@appsemble/utils 0.30.14-test.6 → 0.32.1-test.14

package/api/index.test.js

@@ -1,180 +0,0 @@
-import { readdirSync } from 'node:fs';
-import { readFile } from 'node:fs/promises';
-import { createValidator } from 'koas-core/lib/validation.js';
-import { describe, expect, it } from 'vitest';
-import { parse } from 'yaml';
-import { api, schemas } from './index.js';
-describe('schemas', () => {
-    const document = api('');
-    const validator = createValidator(document);
-    const entries = Object.entries(validator.schemas);
-    describe('boolean', () => {
-        it.each(entries.filter(([, schema]) => schema.type === 'boolean'))('%s', (path, schema) => {
-            expect(schema).not.toHaveProperty('additionalItems');
-            expect(schema).not.toHaveProperty('additionalProperties');
-            expect(schema).not.toHaveProperty('allOf');
-            expect(schema).not.toHaveProperty('anyOf');
-            expect(schema).not.toHaveProperty('const');
-            // Expect(schema).toHaveProperty('description');
-            expect(schema).not.toHaveProperty('else');
-            expect(schema).not.toHaveProperty('enum');
-            expect(schema).not.toHaveProperty('exclusiveMaximum');
-            expect(schema).not.toHaveProperty('exclusiveMinimum');
-            expect(schema).not.toHaveProperty('format');
-            expect(schema).not.toHaveProperty('if');
-            expect(schema).not.toHaveProperty('maximum');
-            expect(schema).not.toHaveProperty('maxItems');
-            expect(schema).not.toHaveProperty('maxLength');
-            expect(schema).not.toHaveProperty('minimum');
-            expect(schema).not.toHaveProperty('minItems');
-            expect(schema).not.toHaveProperty('minLength');
-            expect(schema).not.toHaveProperty('multipleOf');
-            expect(schema).not.toHaveProperty('oneOf');
-            expect(schema).not.toHaveProperty('required');
-            expect(schema).not.toHaveProperty('then');
-            expect(schema).not.toHaveProperty('uniqueItems');
-        });
-    });
-    describe('enum', () => {
-        it.each(entries.filter(([, schema]) => schema.enum))('%s', (path, schema) => {
-            expect(schema).not.toHaveProperty('additionalItems');
-            expect(schema).not.toHaveProperty('additionalProperties');
-            expect(schema).not.toHaveProperty('allOf');
-            expect(schema).not.toHaveProperty('anyOf');
-            expect(schema).not.toHaveProperty('const');
-            // Expect(schema).toHaveProperty('description');
-            expect(schema).not.toHaveProperty('else');
-            expect(schema).not.toHaveProperty('exclusiveMaximum');
-            expect(schema).not.toHaveProperty('exclusiveMinimum');
-            expect(schema).not.toHaveProperty('format');
-            expect(schema).not.toHaveProperty('if');
-            expect(schema).not.toHaveProperty('maximum');
-            expect(schema).not.toHaveProperty('maxItems');
-            expect(schema).not.toHaveProperty('maxLength');
-            expect(schema).not.toHaveProperty('minimum');
-            expect(schema).not.toHaveProperty('minItems');
-            expect(schema).not.toHaveProperty('minLength');
-            expect(schema).not.toHaveProperty('multipleOf');
-            expect(schema).not.toHaveProperty('oneOf');
-            expect(schema).not.toHaveProperty('required');
-            expect(schema).not.toHaveProperty('then');
-            expect(schema).not.toHaveProperty('type');
-            expect(schema).not.toHaveProperty('uniqueItems');
-        });
-    });
-    describe('object', () => {
-        it.each(entries.filter(([, schema]) => schema.type === 'object'))('%s', (path, schema) => {
-            // Action descriptions are defined on the type property.
-            const descriptionSchema = path.endsWith('ActionDefinition') ? schema.properties.type : schema;
-            const isTabsPageDefinition = path.endsWith('TabsPageDefinition');
-            expect(schema).not.toHaveProperty('additionalItems');
-            expect(schema).toHaveProperty('additionalProperties');
-            expect(schema).not.toHaveProperty('allOf');
-            expect(schema).not.toHaveProperty('anyOf');
-            expect(schema).not.toHaveProperty('const');
-            expect(descriptionSchema).toHaveProperty('description');
-            expect(schema).not.toHaveProperty('else');
-            expect(schema).not.toHaveProperty('enum');
-            expect(schema).not.toHaveProperty('exclusiveMaximum');
-            expect(schema).not.toHaveProperty('exclusiveMinimum');
-            expect(schema).not.toHaveProperty('format');
-            expect(schema).not.toHaveProperty('if');
-            expect(schema).not.toHaveProperty('maximum');
-            expect(schema).not.toHaveProperty('maxItems');
-            expect(schema).not.toHaveProperty('maxLength');
-            expect(schema).not.toHaveProperty('minimum');
-            expect(schema).not.toHaveProperty('minItems');
-            expect(schema).not.toHaveProperty('minLength');
-            expect(schema).not.toHaveProperty('multipleOf');
-            if (!isTabsPageDefinition) {
-                // eslint-disable-next-line vitest/no-conditional-expect
-                expect(schema).not.toHaveProperty('oneOf');
-            }
-            expect(schema).not.toHaveProperty('then');
-            expect(schema).not.toHaveProperty('uniqueItems');
-            if (schema.required && !schema.additionalProperties) {
-                for (const name of schema.required) {
-                    // eslint-disable-next-line vitest/no-conditional-expect
-                    expect(schema.properties).toHaveProperty(name);
-                }
-            }
-        });
-    });
-    describe('number', () => {
-        it.each(entries.filter(([, schema]) => schema.type === 'number' || schema.type === 'integer'))('%s', (path, schema) => {
-            expect(schema).not.toHaveProperty('additionalItems');
-            expect(schema).not.toHaveProperty('additionalProperties');
-            expect(schema).not.toHaveProperty('allOf');
-            expect(schema).not.toHaveProperty('anyOf');
-            expect(schema).not.toHaveProperty('const');
-            // Expect(schema).toHaveProperty('description');
-            expect(schema).not.toHaveProperty('else');
-            expect(schema).not.toHaveProperty('enum');
-            expect(schema).not.toHaveProperty('format');
-            expect(schema).not.toHaveProperty('if');
-            expect(schema).not.toHaveProperty('maxItems');
-            expect(schema).not.toHaveProperty('maxLength');
-            expect(schema).not.toHaveProperty('minLength');
-            expect(schema).not.toHaveProperty('minItems');
-            expect(schema).not.toHaveProperty('multipleOf');
-            expect(schema).not.toHaveProperty('oneOf');
-            expect(schema).not.toHaveProperty('required');
-            expect(schema).not.toHaveProperty('then');
-            expect(schema).not.toHaveProperty('uniqueItems');
-        });
-    });
-    describe('string', () => {
-        it.each(entries.filter(([, schema]) => schema.type === 'string'))('%s', (path, schema) => {
-            expect(schema).not.toHaveProperty('additionalItems');
-            expect(schema).not.toHaveProperty('additionalProperties');
-            expect(schema).not.toHaveProperty('allOf');
-            expect(schema).not.toHaveProperty('anyOf');
-            expect(schema).not.toHaveProperty('const');
-            // Expect(schema).toHaveProperty('description');
-            expect(schema).not.toHaveProperty('else');
-            expect(schema).not.toHaveProperty('enum');
-            expect(schema).not.toHaveProperty('exclusiveMaximum');
-            expect(schema).not.toHaveProperty('exclusiveMinimum');
-            expect(schema).not.toHaveProperty('if');
-            expect(schema).not.toHaveProperty('maximum');
-            expect(schema).not.toHaveProperty('maxItems');
-            // Expect(schema).toHaveProperty('maxLength');
-            expect(schema).not.toHaveProperty('minimum');
-            expect(schema).not.toHaveProperty('minItems');
-            expect(schema).not.toHaveProperty('multipleOf');
-            expect(schema).not.toHaveProperty('oneOf');
-            expect(schema).not.toHaveProperty('required');
-            expect(schema).not.toHaveProperty('then');
-            expect(schema).not.toHaveProperty('uniqueItems');
-        });
-    });
-    describe('validation', () => {
-        const testsDir = new URL('schema-tests/', import.meta.url);
-        describe.each(readdirSync(testsDir))('%s', (name) => {
-            const schema = schemas[name];
-            it('should reference an existing schema', () => {
-                expect(schemas).toHaveProperty(name);
-            });
-            describe('valid', () => {
-                const valid = new URL(`${name}/valid/`, testsDir);
-                it.each(readdirSync(valid))('%s', async (filename) => {
-                    const buffer = await readFile(new URL(filename, valid), 'utf8');
-                    expect(buffer).toMatch(new RegExp(`^# yaml-language-server: \\$schema=https://appsemble.app/api.json#/components/schemas/${name}\n`));
-                    const instance = parse(buffer);
-                    const result = validator.validate(instance, schema, { base: '#', nestedErrors: true });
-                    expect(result.valid).toBe(true);
-                });
-            });
-            describe('invalid', () => {
-                const invalid = new URL(`${name}/invalid/`, testsDir);
-                it.each(readdirSync(invalid))('%s', async (filename) => {
-                    const buffer = await readFile(new URL(filename, invalid), 'utf8');
-                    const instance = parse(buffer);
-                    const result = validator.validate(instance, schema, { base: '#', nestedErrors: true });
-                    expect(result.valid).toBe(false);
-                });
-            });
-        });
-    });
-});
-//# sourceMappingURL=index.test.js.map

package/api/paths/trainingBlocks/trainingBlockId.js

@@ -1,41 +0,0 @@
-export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/trainingBlockId' }],
-    patch: {
-        tags: ['main', 'training-block'],
-        description: 'Update a training block with new content',
-        operationId: 'patchTrainingBlock',
-        requestBody: {
-            required: true,
-            content: {
-                'multipart/form-data': {
-                    schema: {
-                        type: 'object',
-                        properties: {
-                            documentationLink: {
-                                $ref: '#/components/schemas/TrainingBlock/properties/documentationLink',
-                            },
-                            videoLink: { $ref: '#/components/schemas/TrainingBlock/properties/videoLink' },
-                            exampleCode: { $ref: '#/components/schemas/TrainingBlock/properties/exampleCode' },
-                            title: { $ref: '#/components/schemas/TrainingBlock/properties/title' },
-                            externalResource: {
-                                $ref: '#/components/schemas/TrainingBlock/properties/externalResource',
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        responses: { 200: { $ref: '#/components/schemas/TrainingBlock' } },
-        security: [{ studio: [] }],
-    },
-    delete: {
-        tags: ['main', 'training-block'],
-        description: 'Delete a training block by Id.',
-        operationId: 'deleteTrainingBlock',
-        responses: {
-            204: { description: 'Deleted the specified training block.' },
-        },
-        security: [{ studio: [] }],
-    },
-};
-//# sourceMappingURL=trainingBlockId.js.map

package/api/paths/trainings/trainingId/blocks.js

@@ -1,51 +0,0 @@
-export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/trainingId' }],
-    get: {
-        tags: ['main', 'training', 'training-block'],
-        description: 'Fetch all training blocks by training id',
-        operationId: 'getTrainingBlocksByTrainingId',
-        responses: {
-            200: {
-                description: 'An array of all the training Blocks associated with a training.',
-                content: {
-                    'application/json': {
-                        schema: {
-                            type: 'array',
-                            items: { $ref: '#/components/schemas/TrainingBlock' },
-                        },
-                    },
-                },
-            },
-        },
-        security: [{ studio: [] }, {}],
-    },
-    post: {
-        tags: ['main', 'training', 'training-block'],
-        description: 'Create a new training block as a child of a training.',
-        operationId: 'createTrainingBlock',
-        requestBody: {
-            required: true,
-            content: {
-                'multipart/form-data': {
-                    schema: {
-                        type: 'object',
-                        properties: {
-                            documentationLink: {
-                                $ref: '#/components/schemas/TrainingBlock/properties/documentationLink',
-                            },
-                            videoLink: { $ref: '#/components/schemas/TrainingBlock/properties/videoLink' },
-                            exampleCode: { $ref: '#/components/schemas/TrainingBlock/properties/exampleCode' },
-                            title: { $ref: '#/components/schemas/TrainingBlock/properties/title' },
-                            externalResource: {
-                                $ref: '#/components/schemas/TrainingBlock/properties/externalResource',
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        responses: { 201: { description: 'Created new training block successfully' } },
-        security: [{ studio: [] }],
-    },
-};
-//# sourceMappingURL=blocks.js.map

package/api/paths/trainings/trainingId/users/current.js

@@ -1,62 +0,0 @@
-export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/trainingId' }],
-    get: {
-        tags: ['main', 'training', 'user'],
-        description: 'Check if a user is enrolled in a training.',
-        operationId: 'isCurrentUserEnrolledInTraining',
-        responses: {
-            200: {
-                description: 'A boolean returning whether a user is enrolled in a training',
-                content: {
-                    'application/json': {
-                        schema: {
-                            type: 'object',
-                            properties: {
-                                enrolled: {
-                                    type: 'boolean',
-                                    description: 'If a user is enrolled in a training',
-                                },
-                                completed: {
-                                    type: 'boolean',
-                                    description: 'If the training has been completed by the user.',
-                                },
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        security: [{ studio: [] }],
-    },
-    post: {
-        tags: ['main', 'training', 'user'],
-        description: 'Enroll a user in a training.',
-        operationId: 'enrollCurrentUserInTraining',
-        responses: { 201: { description: 'Enrolled in the training successfully' } },
-        security: [{ studio: [] }],
-    },
-    patch: {
-        tags: ['main', 'training', 'user'],
-        description: 'Edit an enrollment of a user in a training',
-        operationId: 'setCurrentUserTrainingCompleted',
-        requestBody: {
-            required: true,
-            content: {
-                'multipart/form-data': {
-                    schema: {
-                        type: 'object',
-                        properties: {
-                            completed: {
-                                type: 'boolean',
-                                description: 'If the training has been completed by the user.',
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        responses: { 200: { description: 'Updated user training successfully.' } },
-        security: [{ studio: [] }],
-    },
-};
-//# sourceMappingURL=current.js.map

package/api/paths/trainings/trainingId/users.js

@@ -1,25 +0,0 @@
-export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/trainingId' }],
-    get: {
-        tags: ['main', 'training', 'user'],
-        description: 'Get a list of all users who have completed a training.',
-        operationId: 'getTrainedUsers',
-        responses: {
-            200: {
-                description: 'A list of all the users who have completed a training.',
-                content: {
-                    'application/json': {
-                        schema: {
-                            type: 'array',
-                            items: {
-                                $ref: '#/components/schemas/User',
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        security: [{ studio: [] }],
-    },
-};
-//# sourceMappingURL=users.js.map

package/api/paths/trainings/trainingId.js

@@ -1,85 +0,0 @@
-export const pathItems = {
-    parameters: [{ $ref: '#/components/parameters/trainingId' }],
-    get: {
-        tags: ['main', 'training'],
-        description: 'Fetch a single training by id.',
-        operationId: 'getTrainingById',
-        responses: {
-            200: {
-                description: 'Object representation of a training',
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: '#/components/schemas/Training',
-                        },
-                    },
-                },
-            },
-        },
-        security: [{ studio: [] }, {}],
-    },
-    patch: {
-        tags: ['main', 'training'],
-        description: 'Fetch a single training by id.',
-        operationId: 'patchTraining',
-        requestBody: {
-            required: true,
-            content: {
-                'multipart/form-data': {
-                    schema: {
-                        description: 'Schema to be used for editing trainings.',
-                        properties: {
-                            id: {
-                                type: 'number',
-                                readOnly: true,
-                                minimum: 0,
-                                description: 'The id of the training, will be generated automatically by the system.',
-                            },
-                            title: {
-                                type: 'string',
-                                description: 'Title of the training.',
-                            },
-                            description: {
-                                type: 'string',
-                                description: 'A brief overview of the training.',
-                            },
-                            competence: {
-                                type: 'string',
-                                description: 'Competence tags for the training',
-                            },
-                            difficultyLevel: {
-                                type: 'number',
-                                description: 'Difficulty level between 1 and 5',
-                                minimum: 1,
-                                maximum: 5,
-                            },
-                        },
-                    },
-                },
-            },
-        },
-        responses: {
-            200: {
-                description: 'Object representation of a training',
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: '#/components/schemas/Training',
-                        },
-                    },
-                },
-            },
-        },
-        security: [{ studio: [] }],
-    },
-    delete: {
-        tags: ['main', 'training'],
-        description: 'Delete a training by Id.',
-        operationId: 'deleteTraining',
-        responses: {
-            204: { description: 'Deleted the specified training.' },
-        },
-        security: [{ studio: [] }],
-    },
-};
-//# sourceMappingURL=trainingId.js.map

package/api/paths/trainings.js

@@ -1,44 +0,0 @@
-export const pathItems = {
-    get: {
-        tags: ['main', 'training'],
-        description: 'Fetch all trainings available',
-        operationId: 'getTrainings',
-        responses: {
-            200: {
-                description: 'An array of all the available trainings.',
-                content: {
-                    'application/json': {
-                        schema: {
-                            type: 'array',
-                            items: { $ref: '#/components/schemas/Training' },
-                        },
-                    },
-                },
-            },
-        },
-        security: [{ studio: [] }, {}],
-    },
-    post: {
-        tags: ['main', 'training'],
-        description: '',
-        operationId: 'createTraining',
-        requestBody: {
-            required: true,
-            content: {
-                'application/json': {
-                    schema: {
-                        $ref: '#/components/schemas/Training',
-                    },
-                },
-            },
-        },
-        responses: {
-            201: {
-                description: 'Created new training successfully',
-                $ref: '#/components/schemas/Training',
-            },
-        },
-        security: [{ studio: [] }],
-    },
-};
-//# sourceMappingURL=trainings.js.map

package/appMessages.test.d.ts

@@ -1 +0,0 @@
-export {};