diff --git a/prisma/schema.prisma b/prisma/schema.prisma index f8e84ca..62238db 100644 --- a/prisma/schema.prisma +++ b/prisma/schema.prisma @@ -13,21 +13,20 @@ datasource db { url = env("DATABASE_URL") } - // START AUTH STUFF + enum UserRole { USER ADMIN } enum ProgramRole { - WRITE + EDITOR ADMIN } enum CourseRole { - READ - WRITE + EDITOR ADMIN } @@ -88,8 +87,8 @@ model VerificationToken { @@id([identifier, token]) } -// END AUTH STUFF +// END AUTH STUFF model Program { id Int @id @default(autoincrement()) @@ -105,7 +104,7 @@ model Program { model ProgramUser { userId String programId Int - role ProgramRole @default(WRITE) + role ProgramRole @default(EDITOR) user User @relation(fields: [userId], references: [id], onDelete: Cascade) program Program @relation(fields: [programId], references: [id], onDelete: Cascade) @@ -117,7 +116,7 @@ model ProgramUser { model CourseUser { userId String courseId Int - role CourseRole @default(READ) + role CourseRole @default(EDITOR) user User @relation(fields: [userId], references: [id], onDelete: Cascade) course Course @relation(fields: [courseId], references: [id], onDelete: Cascade) @@ -155,7 +154,6 @@ model Graph { subjects Subject[] lectures Lecture[] links GraphLink[] - // UI names createdAt DateTime @default(now()) updatedAt DateTime @updatedAt } @@ -163,11 +161,11 @@ model Graph { model Domain { id Int @id @default(autoincrement()) - name String? + name String @default("") x Int @default(0) y Int @default(0) style String? - graph Graph @relation(fields: [graphId], references: [id]) + graph Graph @relation(fields: [graphId], references: [id], onDelete: Cascade) graphId Int subjects Subject[] parentDomains Domain[] @relation("DomainRelation") @@ -177,11 +175,11 @@ model Domain { model Subject { id Int @id @default(autoincrement()) - name String? + name String @default("") x Int @default(0) y Int @default(0) style String? - graph Graph @relation(fields: [graphId], references: [id]) + graph Graph @relation(fields: [graphId], references: [id], onDelete: Cascade) graphId Int domain Domain? @relation(fields: [domainId], references: [id]) domainId Int? @@ -206,9 +204,9 @@ model SubjectLecture { model Lecture { id Int @id @default(autoincrement()) - graph Graph @relation(fields: [graphId], references: [id]) + graph Graph @relation(fields: [graphId], references: [id], onDelete: Cascade) graphId Int - name String? + name String @default("") subjects SubjectLecture[] } @@ -218,7 +216,6 @@ model GraphLink { name String courseId Int graphId Int? - course Course @relation(fields: [courseId], references: [id], onDelete: Cascade) graph Graph? @relation(fields: [graphId], references: [id]) } diff --git a/src/lib/components/GraphSVG.svelte b/src/lib/components/GraphSVG.svelte index d363f75..451b484 100644 --- a/src/lib/components/GraphSVG.svelte +++ b/src/lib/components/GraphSVG.svelte @@ -7,7 +7,7 @@ import { graph } from '$stores' // Components - import Dropdown from './Dropdown.svelte' + import Dropdown from './forms/Dropdown.svelte' // Assets import zoomInIcon from '$assets/zoom-in-icon.svg' diff --git a/src/lib/components/Tabular.svelte b/src/lib/components/Tabular.svelte deleted file mode 100644 index 93a3c01..0000000 --- a/src/lib/components/Tabular.svelte +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - -
-
- {#each tabs as tab, index} - - {/each} - -
-
- - -
- - - - - - diff --git a/src/lib/components/Tooltip.svelte b/src/lib/components/Tooltip.svelte index 9c5e124..b7bde6c 100644 --- a/src/lib/components/Tooltip.svelte +++ b/src/lib/components/Tooltip.svelte @@ -33,7 +33,7 @@ .tooltip position: absolute translate: -50% calc(-100% - 10px) - z-index: 9999 + z-index: 9998 width: max-content padding: 0 $input-thick-padding diff --git a/src/lib/components/Validation.svelte b/src/lib/components/Validation.svelte index 3bf35d6..95b54b4 100644 --- a/src/lib/components/Validation.svelte +++ b/src/lib/components/Validation.svelte @@ -2,7 +2,7 @@ @@ -52,43 +68,51 @@
- you shouldn't see this -
set(false)} bind:this={wrapper}> +
visibility(false)} bind:this={wrapper}> - + {#if visible} -
- {#each options as option} - + {#each options as option} + {#if options.length < 5 || option.label.toLowerCase().includes(query.toLowerCase())} + + {/if} {/each} {#if options.length === 0} @@ -97,8 +121,8 @@ {/if} - {#if value !== undefined} - {/if} @@ -118,21 +142,17 @@ $caret-size: calc($input-icon-size / sqrt(2)) - .grayed - color: $placeholder-color - .dropdown position: relative width: 100% - padding: $input-thin-padding $input-thick-padding - .wrapper position: absolute top: 0 left: 0 width: 100% + height: auto overflow: hidden .header @@ -146,7 +166,6 @@ bottom: $input-thin-padding left: $input-thick-padding - overflow: hidden text-overflow: ellipsis white-space: nowrap @@ -239,6 +258,18 @@ img filter: $yellow-filter + + .searchbar + position: relative + padding-right: calc($input-icon-size + 2 * $input-thin-padding) + + img + position: absolute + right: $input-thin-padding + width: $input-icon-size + height: $input-icon-size + + filter: $gray-filter &.visible .header border-color: $tudelft-blue diff --git a/src/lib/components/Search.svelte b/src/lib/components/forms/Search.svelte similarity index 100% rename from src/lib/components/Search.svelte rename to src/lib/components/forms/Search.svelte diff --git a/src/lib/components/Textfield.svelte b/src/lib/components/forms/Textfield.svelte similarity index 57% rename from src/lib/components/Textfield.svelte rename to src/lib/components/forms/Textfield.svelte index a51dd81..fcb0168 100644 --- a/src/lib/components/Textfield.svelte +++ b/src/lib/components/forms/Textfield.svelte @@ -2,25 +2,25 @@ @@ -29,21 +29,21 @@ -{#if obfuscate} +{#if type === 'obfuscated'}
@@ -52,12 +52,14 @@ {/if} @@ -70,7 +72,7 @@ @use "$styles/variables.sass" as * @use "$styles/palette.sass" as * - + input width: 100% padding: $input-thin-padding $input-thick-padding @@ -84,7 +86,14 @@ &:focus border-color: $tudelft-blue - + + &.subtle + border-color: transparent + transition: border-color $default-transition + + &:hover + border-color: $gray + div width: 100% position: relative diff --git a/src/lib/components/Card.svelte b/src/lib/components/layouts/Card.svelte similarity index 100% rename from src/lib/components/Card.svelte rename to src/lib/components/layouts/Card.svelte diff --git a/src/lib/layouts/DefaultLayout.svelte b/src/lib/components/layouts/DefaultLayout.svelte similarity index 93% rename from src/lib/layouts/DefaultLayout.svelte rename to src/lib/components/layouts/DefaultLayout.svelte index 0900385..da3e11e 100644 --- a/src/lib/layouts/DefaultLayout.svelte +++ b/src/lib/components/layouts/DefaultLayout.svelte @@ -2,7 +2,6 @@ @@ -24,7 +23,7 @@ {/each} - {description} + {#if $$slots.toolbar} diff --git a/src/lib/components/Infobox.svelte b/src/lib/components/layouts/Infobox.svelte similarity index 100% rename from src/lib/components/Infobox.svelte rename to src/lib/components/layouts/Infobox.svelte diff --git a/src/lib/components/Modal.svelte b/src/lib/components/layouts/Modal.svelte similarity index 90% rename from src/lib/components/Modal.svelte rename to src/lib/components/layouts/Modal.svelte index a1f372e..333719a 100644 --- a/src/lib/components/Modal.svelte +++ b/src/lib/components/layouts/Modal.svelte @@ -38,6 +38,9 @@
+
+ +
{/if} @@ -80,6 +83,13 @@ background-color: $white border-radius: $border-radius + footer + display: flex + flex-flow: row nowrap + justify-content: flex-end + align-items: center + gap: $form-small-gap + .exit display: flex align-items: center diff --git a/src/lib/components/layouts/Tabular.svelte b/src/lib/components/layouts/Tabular.svelte new file mode 100644 index 0000000..17836cf --- /dev/null +++ b/src/lib/components/layouts/Tabular.svelte @@ -0,0 +1,110 @@ + + + + + + + +
+
+ {#each tabs as { title }, n} + + {/each} + +
+
+ + {#each tabs as { content, props }, n} + {#if active === n} + + {/if} + {/each} +
+ + + + + + \ No newline at end of file diff --git a/src/lib/scripts/d3/FieldSVG.ts b/src/lib/scripts/SVGControllers/FieldSVGController.ts similarity index 69% rename from src/lib/scripts/d3/FieldSVG.ts rename to src/lib/scripts/SVGControllers/FieldSVGController.ts index 6a757b6..369e14b 100644 --- a/src/lib/scripts/d3/FieldSVG.ts +++ b/src/lib/scripts/SVGControllers/FieldSVGController.ts @@ -3,30 +3,36 @@ import * as d3 from 'd3' // Internal imports -import { GraphSVG, RelationSVG } from '../d3' -import { Field, Domain, Subject, Relation, Lecture } from '../entities' -import * as settings from '../settings' -import { styles } from '../settings' +import { + GraphSVGController, + RelationSVGController +} from '$scripts/SVGControllers' + +import { + FieldController, + DomainController, + SubjectController, + RelationController, + LectureController +} from '$scripts/controllers' + +import * as settings from '$scripts/settings' +import { styles } from '$scripts/settings' // Exports -export { FieldSVG } - - -// --------------------> Types - - -type FieldSelection = d3.Selection, d3.BaseType, unknown> +export { FieldSVGController } // --------------------> Classes +type FieldSelection = d3.Selection, d3.BaseType, unknown> -class FieldSVG { - static create(selection: FieldSelection, graphSVG: GraphSVG) { +class FieldSVGController { + static create(selection: FieldSelection, graphSVG: GraphSVGController) { - // Field attrs + // Field attributes selection - .attr('id', field => field.anchor) + .attr('id', field => field.uuid) .attr('class', 'field fixed') .attr('transform', field => `translate( ${field.x * settings.GRID_UNIT}, @@ -46,7 +52,7 @@ class FieldSVG { .style('text-anchor', 'middle') .style('dominant-baseline', 'middle') .style('font-size', settings.FIELD_FONT_SIZE) - + // Wrap text selection .selectAll('text') @@ -74,7 +80,7 @@ class FieldSVG { const scale = Math.min(1, max_width / tspan.node()!.getComputedTextLength()) const font_size = settings.FIELD_FONT_SIZE * scale element.attr('font-size', font_size) - + // Wrap text let line_count = 0 let line: string[] = [] @@ -100,29 +106,30 @@ class FieldSVG { // Drag behaviour selection.call( - d3.drag>() + d3.drag>() .on('start', function() { - const selection = d3.select>(this) - selection.call(FieldSVG.setFixed, true) + const selection = d3.select>(this) + selection.call(FieldSVGController.setFixed, true) }) .on('drag', function(event, field) { - const selection = d3.select>(this) + const selection = d3.select>(this) field.x = field.x + event.dx / settings.GRID_UNIT field.y = field.y + event.dy / settings.GRID_UNIT field.fx = field.x field.fy = field.y - - FieldSVG.updatePosition(selection) + + FieldSVGController.updatePosition(selection) graphSVG.microwaveSimulation() }) - .on('end', function(_ ,field) { - const selection = d3.select>(this) + .on('end', async function(_ ,field) { + const selection = d3.select>(this) field.x = Math.round(field.x) field.y = Math.round(field.y) field.fx = field.x field.fy = field.y - FieldSVG.updatePosition(selection) + FieldSVGController.updatePosition(selection) + await field.save() }) ) } @@ -145,18 +152,18 @@ class FieldSVG { // Update relations selection.each(function(field) { - content.selectAll>('.relation') + content.selectAll>('.relation') .filter(relation => relation.parent === field || relation.child === field) - .call(RelationSVG.update, animated) + .call(RelationSVGController.update, animated) }) } - static updateHighlight(selection: FieldSelection, lecture?: Lecture) { + static updateHighlight(selection: FieldSelection, lecture?: LectureController) { selection .each(function(field) { - const highlight = - field instanceof Domain && lecture?.present.some(subject => subject.domain === field) || - field instanceof Subject && lecture?.present.includes(field) + const highlight = + field instanceof DomainController && lecture?.present.some(subject => subject.domain === field) || + field instanceof SubjectController && lecture?.present.includes(field) d3.select(this) .attr('filter', highlight ? 'url(#highlight)' : null) @@ -167,13 +174,13 @@ class FieldSVG { selection .classed('fixed', fixed) .attr('stroke-dasharray', fixed ? null : settings.STROKE_DASHARRAY) - .each((field) => { + .each(field => { field.x = fixed ? Math.round(field.x) : field.x field.y = fixed ? Math.round(field.y) : field.y field.fx = fixed ? field.x : undefined field.fy = fixed ? field.y : undefined }) - - FieldSVG.updatePosition(selection) + + FieldSVGController.updatePosition(selection) } } diff --git a/src/lib/scripts/d3/GraphSVG.ts b/src/lib/scripts/SVGControllers/GraphSVGController.ts similarity index 84% rename from src/lib/scripts/d3/GraphSVG.ts rename to src/lib/scripts/SVGControllers/GraphSVGController.ts index 811f276..de4a639 100644 --- a/src/lib/scripts/d3/GraphSVG.ts +++ b/src/lib/scripts/SVGControllers/GraphSVGController.ts @@ -3,14 +3,30 @@ import * as d3 from 'd3' // Internal imports -import { Graph, Field, Domain, Subject, Relation, Lecture, Severity } from '../entities' -import { FieldSVG, RelationSVG, OverlaySVG } from '.' -import * as settings from '../settings' +import { + FieldSVGController, + RelationSVGController, + OverlaySVGController +} from '$scripts/SVGControllers' + +import { + GraphController, + DomainController, + SubjectController, + RelationController, + LectureController, + FieldController +} from '$scripts/controllers' + +import { Severity } from '$scripts/validation' +import * as settings from '$scripts/settings' // Exports -export { GraphSVG, View, State } +export { GraphSVGController, View, State } + + +// --------------------> Classes -// --------------------> Types const ANIMATE = () => {} @@ -28,13 +44,13 @@ enum View { lectures } -class GraphSVG { - private graph: Graph +class GraphSVGController { + private graph: GraphController private interactive: boolean private _view: View private _state: State - private _lecture?: Lecture + private _lecture?: LectureController private svg?: SVGSVGElement private zoom?: d3.ZoomBehavior @@ -43,12 +59,16 @@ class GraphSVG { private keys: { [key: string]: boolean } = {} shift_required: boolean = true - constructor(graph: Graph, interactive: boolean = true) { + constructor(graph: GraphController, interactive: boolean = true) { this.graph = graph this.interactive = interactive this._view = View.domains - this._state = interactive ? State.dynamic : State.static + if (this.validateView(this.view)) { + this._state = interactive ? State.dynamic : State.static + } else { + this._state = State.broken + } } get view() { @@ -56,9 +76,8 @@ class GraphSVG { } set view(view: View) { - if (this.view === view || - this.state === State.animating - ) return + if (this.view === view || this.state === State.animating) + return // Validate view if (!this.validateView(view)) { @@ -106,41 +125,45 @@ class GraphSVG { } private set state(state: State) { - if (this.svg === undefined || this.simulation === undefined) - throw new Error('GraphSVG not attached to DOM') - if (this.state === state) + if (this.svg === undefined || this.simulation === undefined) + throw new Error('Failed to set state: GraphSVG not attached to DOM') + if (this.state === state) return - // If moving out of dynamic state + // If moving out of dynamic state: + // - Disable pointer events + // - Fix all fields + // - Save all fields + // - Stop simulation if (this.state === State.dynamic) { d3.select(this.svg) .attr('pointer-events', 'none') .select('#content') - .selectAll>('.field') - .call(FieldSVG.setFixed, true) + .selectAll>('.field') + .call(FieldSVGController.setFixed, true) + .each(async field => await field.save()) this.simulation.stop() } - // If moving out of broken state + // If moving out of broken state, reset overlay if (this.state === State.broken) { d3.select('#overlay') - .call(OverlaySVG.reset) + .call(OverlaySVGController.reset) } this._state = state // NEW STATE - - // If moving into dynamic state + // If moving into dynamic state, enable pointer events if (state === State.dynamic) { d3.select(this.svg) .attr('pointer-events', 'all') } - // If moving into broken state + // If moving into broken state, set overlay to broken if (state === State.broken) { d3.select('#overlay') - .call(OverlaySVG.brokenGraph) + .call(OverlaySVGController.brokenGraph) } } @@ -148,10 +171,10 @@ class GraphSVG { return this._lecture } - set lecture(lecture: Lecture | undefined) { - if (this.svg === undefined) - throw new Error('GraphSVG not attached to DOM') - if (this.lecture === lecture || this.state === State.animating) + set lecture(lecture: LectureController | undefined) { + if (this.svg === undefined) + throw new Error('Failed to set lecture: GraphSVG not attached to DOM') + if (this.lecture === lecture || this.state === State.animating) return this._lecture = lecture @@ -164,7 +187,6 @@ class GraphSVG { // Update content if (this.view === View.lectures) { - this.state = State.lecture this.setBackground(View.lectures) this.moveCamera(0, 0, 1) @@ -179,13 +201,13 @@ class GraphSVG { // Update highlights d3.select(this.svg) .select('#content') - .selectAll>('.field') - .call(FieldSVG.updateHighlight, this.lecture) + .selectAll>('.field') + .call(FieldSVGController.updateHighlight, this.lecture) } get autolayout_enabled() { return d3.select('#content') - .selectAll>('.field:not(.fixed)') + .selectAll>('.field:not(.fixed)') .size() > 0 } @@ -250,7 +272,7 @@ class GraphSVG { svg.on('wheel', () => { if (this.keys.Shift || !this.shift_required) return d3.select('#overlay') - .call(OverlaySVG.shiftScroll, this) + .call(OverlaySVGController.shiftScroll, this) }) // Keylogging @@ -293,8 +315,8 @@ class GraphSVG { .force('charge', d3.forceManyBody().strength(settings.CHARGE_FORCE)) .on('tick', () => { d3.select('#content') - .selectAll>('.field') - .call(FieldSVG.updatePosition) + .selectAll>('.field') + .call(FieldSVGController.updatePosition) }) @@ -306,9 +328,9 @@ class GraphSVG { } zoomIn() { - if (this.svg === undefined || this.zoom === undefined) + if (this.svg === undefined || this.zoom === undefined) throw new Error('GraphSVG not attached to DOM') - if (this.state !== State.dynamic) + if (this.state !== State.dynamic) return d3.select(this.svg) @@ -319,9 +341,9 @@ class GraphSVG { } zoomOut() { - if (this.svg === undefined || this.zoom === undefined) + if (this.svg === undefined || this.zoom === undefined) throw new Error('GraphSVG not attached to DOM') - if (this.state !== State.dynamic) + if (this.state !== State.dynamic) return d3.select(this.svg) @@ -349,8 +371,9 @@ class GraphSVG { const autolayout_enabled = this.autolayout_enabled d3.select('#content') - .selectAll>('.field') - .call(FieldSVG.setFixed, autolayout_enabled) + .selectAll>('.field') + .call(FieldSVGController.setFixed, autolayout_enabled) + .each(async field => { if (autolayout_enabled) await field.save() }) if (autolayout_enabled) { this.simulation.stop() @@ -373,7 +396,7 @@ class GraphSVG { return this.graph.domains.every(domain => domain.validate().severity !== Severity.error) case View.subjects: - return this.graph.subjects.every(subject => + return this.graph.subjects.every(subject => subject.domain?.style !== undefined && subject.validate().severity !== Severity.error ) @@ -381,13 +404,13 @@ class GraphSVG { case View.lectures: return ( this.lecture === undefined || - this.lecture.validate().severity !== Severity.error && + this.lecture.validate().severity !== Severity.error && this.lecture.subjects.every(subject => subject.validate().severity !== Severity.error) ) } } - private boundingBox(fields: Field[]) { + private boundingBox(fields: FieldController[]) { if (this.svg === undefined) throw new Error('GraphSVG not attached to DOM') @@ -420,7 +443,7 @@ class GraphSVG { } private moveCamera(x: number, y: number, k: number, callback?: () => void) { - if (this.svg === undefined || this.zoom === undefined) + if (this.svg === undefined || this.zoom === undefined) throw new Error('GraphSVG not attached to DOM') // Call zoom with custom transform @@ -447,7 +470,7 @@ class GraphSVG { } private panCamera(x: number, y: number, callback?: () => void) { - if (this.svg === undefined || this.zoom === undefined) + if (this.svg === undefined || this.zoom === undefined) throw new Error('GraphSVG not attached to DOM') // Call zoom with custom transform @@ -470,7 +493,7 @@ class GraphSVG { } private zoomCamera(k: number, callback?: () => void) { - if (this.svg === undefined || this.zoom === undefined) + if (this.svg === undefined || this.zoom === undefined) throw new Error('GraphSVG not attached to DOM') // Call zoom with custom transform @@ -572,8 +595,8 @@ class GraphSVG { .remove() } - private setContent(fields: Field[], relations: Relation[], callback?: () => void) { - if (this.simulation === undefined) + private setContent(fields: FieldController[], relations: RelationController[], callback?: () => void) { + if (this.simulation === undefined) throw new Error('GraphSVG not attached to DOM') const content = d3.select('#content') @@ -581,20 +604,20 @@ class GraphSVG { const graphSVG = this // Update Fields - content.selectAll>('.field') - .data(fields, field => field.anchor) + content.selectAll>('.field') + .data(fields, field => field.uuid) .join( function(enter) { return enter .append('g') - .call(FieldSVG.create, graphSVG) - .call(FieldSVG.updateHighlight, lecture) + .call(FieldSVGController.create, graphSVG) + .call(FieldSVGController.updateHighlight, lecture) .style('opacity', 0) }, function(update) { return update - .call(FieldSVG.updateHighlight, lecture) + .call(FieldSVGController.updateHighlight, lecture) }, function(exit) { @@ -610,13 +633,13 @@ class GraphSVG { .style('opacity', 1) // Update relations - content.selectAll>('.relation') + content.selectAll>('.relation') .data(relations, relation => relation.anchor) .join( function(enter) { return enter .append('line') - .call(RelationSVG.create) + .call(RelationSVGController.create) .style('opacity', 0) }, @@ -635,7 +658,7 @@ class GraphSVG { .transition() .duration(callback !== undefined ? settings.FADE_DURATION : 0) .style('opacity', 1) - + // Update simulation const links = relations.map(relation => ({ source: relation.parent!, target: relation.child! })) this.simulation @@ -650,7 +673,7 @@ class GraphSVG { } } - private moveContent(fields: Subject[], transform: (field: Subject) => void, callback?: () => void) { + private moveContent(fields: SubjectController[], transform: (field: SubjectController) => void, callback?: () => void) { // Buffer field positions const buffers = fields.map(field => ({ field, x: field.x, y: field.y })) @@ -660,8 +683,8 @@ class GraphSVG { // Update fields d3.select('#content') - .selectAll>('.field') - .call(FieldSVG.updatePosition, callback !== undefined) + .selectAll>('.field') + .call(FieldSVGController.updatePosition, callback !== undefined) // Restore field positions for (const buffer of buffers) { @@ -681,8 +704,8 @@ class GraphSVG { // Update fields d3.select('#content') - .selectAll>('.field') - .call(FieldSVG.updatePosition, callback !== undefined) + .selectAll>('.field') + .call(FieldSVGController.updatePosition, callback !== undefined) // Post-transition if (callback) { @@ -726,7 +749,7 @@ class GraphSVG { this.setContent(this.graph.subjects, this.graph.subject_relations) this.moveContent(this.graph.subjects, this.domainTransform) - this.moveCamera(bbx.x, bbx.y, bbx.k, ANIMATE) + this.moveCamera(bbx.x, bbx.y, bbx.k, ANIMATE) this.restoreContent(() => { this.state = this.interactive ? State.dynamic : State.static }) @@ -765,7 +788,7 @@ class GraphSVG { private subjectToDomain() { const bbx = this.boundingBox(this.graph.domains) - + if (this.state === State.broken) { this.state = State.animating this.moveCamera(bbx.x, bbx.y, bbx.k) @@ -832,7 +855,7 @@ class GraphSVG { } this.state = State.animating - + this.panCamera(bbx.x, bbx.y) this.setBackground(View.domains) this.moveContent(this.lecture.subjects, this.lectureTransform(bbx.x, bbx.y)) @@ -873,14 +896,14 @@ class GraphSVG { }) } - private domainTransform(subject: Subject) { + private domainTransform(subject: SubjectController) { subject.x = subject.domain!.x subject.y = subject.domain!.y } private lectureTransform(x: number, y: number) { const graphSVG = this - return (subject: Subject) => { + return (subject: SubjectController) => { const size = graphSVG.lecture?.size ?? 0 const dx = x - 3 * settings.LECTURE_COLUMN_WIDTH / 2 const dy = y - (settings.LECTURE_HEADER_HEIGHT + size * settings.FIELD_HEIGHT + (size + 1) * settings.LECTURE_PADDING) / 2 diff --git a/src/lib/scripts/d3/OverlaySVG.ts b/src/lib/scripts/SVGControllers/OverlaySVGController.ts similarity index 86% rename from src/lib/scripts/d3/OverlaySVG.ts rename to src/lib/scripts/SVGControllers/OverlaySVGController.ts index 4f3fc81..981bfb3 100644 --- a/src/lib/scripts/d3/OverlaySVG.ts +++ b/src/lib/scripts/SVGControllers/OverlaySVGController.ts @@ -1,25 +1,17 @@ -// External imports -import * as d3 from 'd3' - // Internal imports -import { GraphSVG } from '.' -import * as settings from '../settings' +import { GraphSVGController } from '$scripts/SVGControllers' +import * as settings from '$scripts/settings' // Exports -export { OverlaySVG } - - -// --------------------> - - -type OverlaySelection = d3.Selection +export { OverlaySVGController } // --------------------> Classes +type OverlaySelection = d3.Selection -class OverlaySVG { +class OverlaySVGController { static reset(selection: OverlaySelection) { selection .interrupt() @@ -32,7 +24,7 @@ class OverlaySVG { static brokenGraph(selection: OverlaySelection) { if (selection.classed('broken')) return - OverlaySVG.reset(selection) + OverlaySVGController.reset(selection) selection .attr('class', 'broken') @@ -53,7 +45,7 @@ class OverlaySVG { .attr('fill', 'black') text.append('tspan') - .text('There are outstanding errors') + .text('There are outstanding errors in this graph') .attr('x', '50%') .attr('y', '50%') .attr('dy', settings.OVERLAY_BIG_FONT) @@ -63,9 +55,9 @@ class OverlaySVG { .attr('fill', 'black') } - static shiftScroll(selection: OverlaySelection, graphSVG: GraphSVG) { + static shiftScroll(selection: OverlaySelection, graphSVG: GraphSVGController) { if (!selection.classed('shift-scroll')) { - OverlaySVG.reset(selection) + OverlaySVGController.reset(selection) selection .attr('class', 'shift-scroll') @@ -99,7 +91,7 @@ class OverlaySVG { .attr('fill', 'white') .on('click', () => { graphSVG.shift_required = false - OverlaySVG.reset(selection) + OverlaySVGController.reset(selection) }) } @@ -112,7 +104,7 @@ class OverlaySVG { .delay(settings.OVERLAY_LINGER) .style('opacity', 0) .on('end', () => { - OverlaySVG.reset(selection) + OverlaySVGController.reset(selection) }) } } \ No newline at end of file diff --git a/src/lib/scripts/d3/RelationSVG.ts b/src/lib/scripts/SVGControllers/RelationSVGController.ts similarity index 88% rename from src/lib/scripts/d3/RelationSVG.ts rename to src/lib/scripts/SVGControllers/RelationSVGController.ts index c1f7757..17544b6 100644 --- a/src/lib/scripts/d3/RelationSVG.ts +++ b/src/lib/scripts/SVGControllers/RelationSVGController.ts @@ -3,24 +3,24 @@ import * as d3 from 'd3' // Internal imports -import { Relation, Domain, Subject } from '../entities' -import * as settings from '../settings' -import { styles } from '../settings' +import { + DomainController, + SubjectController, + RelationController +} from '$scripts/controllers' -// Exports -export { RelationSVG } - - -// --------------------> Types +import * as settings from '$scripts/settings' +import { styles } from '$scripts/settings' - -type RelationSelection = d3.Selection, d3.BaseType, unknown> +// Exports +export { RelationSVGController } // --------------------> Classes +type RelationSelection = d3.Selection, d3.BaseType, unknown> -class RelationSVG { +class RelationSVGController { static create(selection: RelationSelection) { selection .attr('id', relation => relation.anchor) @@ -29,7 +29,7 @@ class RelationSVG { .attr('stroke', relation => styles[relation.parent!.style!].stroke) .attr('fill', relation => styles[relation.parent!.style!].stroke) .attr('marker-end', 'url(#arrowhead)') - .call(RelationSVG.update) + .call(RelationSVGController.update) } static update(selection: RelationSelection, animated: boolean = false) { diff --git a/src/lib/scripts/SVGControllers/index.ts b/src/lib/scripts/SVGControllers/index.ts new file mode 100644 index 0000000..251750e --- /dev/null +++ b/src/lib/scripts/SVGControllers/index.ts @@ -0,0 +1,5 @@ + +export { GraphSVGController, View, State } from './GraphSVGController' +export { FieldSVGController } from './FieldSVGController' +export { RelationSVGController } from './RelationSVGController' +export { OverlaySVGController } from './OverlaySVGController' \ No newline at end of file diff --git a/src/lib/scripts/controllers/ControllerCache.ts b/src/lib/scripts/controllers/ControllerCache.ts new file mode 100644 index 0000000..c131269 --- /dev/null +++ b/src/lib/scripts/controllers/ControllerCache.ts @@ -0,0 +1,172 @@ + +// Internal dependencies +import { + UserController, + ProgramController, + CourseController, + GraphController, + DomainController, + SubjectController, + LectureController, + LinkController +} from '$scripts/controllers' + +// Exports +export { ControllerCache } + + +// --------------------> Cache + + +class ControllerCache { + private users: UserController[] = [] + private programs: ProgramController[] = [] + private courses: CourseController[] = [] + private graphs: GraphController[] = [] + private domains: DomainController[] = [] + private subjects: SubjectController[] = [] + private lectures: LectureController[] = [] + private links: LinkController[] = [] + + /** + * Finds an object in the cache + * @param type The type of the object + * @param id The ID of the object + * @returns The found object, or `undefined` if not found + * @throws `CacheError` If the object type is invalid + */ + + find(type: typeof UserController, id: number): UserController | undefined + find(type: typeof ProgramController, id: number): ProgramController | undefined + find(type: typeof CourseController, id: number): CourseController | undefined + find(type: typeof GraphController, id: number): GraphController | undefined + find(type: typeof DomainController, id: number): DomainController | undefined + find(type: typeof SubjectController, id: number): SubjectController | undefined + find(type: typeof LectureController, id: number): LectureController | undefined + find(type: typeof LinkController, id: number): LinkController | undefined + find(type: any, id: number): any { + if (type === UserController) { + return this.users.find(user => user.id === id) + } else if (type === ProgramController) { + return this.programs.find(program => program.id === id) + } else if (type === CourseController) { + return this.courses.find(course => course.id === id) + } else if (type === GraphController) { + return this.graphs.find(graph => graph.id === id) + } else if (type === DomainController) { + return this.domains.find(domain => domain.id === id) + } else if (type === SubjectController) { + return this.subjects.find(subject => subject.id === id) + } else if (type === LectureController) { + return this.lectures.find(lecture => lecture.id === id) + } else if (type === LinkController) { + return this.links.find(link => link.id === id) + } else { + throw new Error(`CacheError: Invalid object type: ${type}`) + } + } + + /** + * Adds objects to the cache + * @param object The object to be added + * @throws `CacheError` If the object already exists in the cache or if the object type is invalid + */ + + add(object: UserController): void + add(object: ProgramController): void + add(object: CourseController): void + add(object: GraphController): void + add(object: DomainController): void + add(object: SubjectController): void + add(object: LectureController): void + add(object: LinkController): void + add(object: any): void { + if (object instanceof UserController) { + if (this.users.some(user => user.id === object.id)) + throw new Error(`CacheError: User with ID ${object.id} already exists`) + this.users.push(object) + } else if (object instanceof ProgramController) { + if (this.programs.some(program => program.id === object.id)) + throw new Error(`CacheError: Program with ID ${object.id} already exists`) + this.programs.push(object) + } else if (object instanceof CourseController) { + if (this.courses.some(course => course.id === object.id)) + throw new Error(`CacheError: Course with ID ${object.id} already exists`) + this.courses.push(object) + } else if (object instanceof GraphController) { + if (this.graphs.some(graph => graph.id === object.id)) + throw new Error(`CacheError: Graph with ID ${object.id} already exists`) + this.graphs.push(object) + } else if (object instanceof DomainController) { + if (this.domains.some(domain => domain.id === object.id)) + throw new Error(`CacheError: Domain with ID ${object.id} already exists`) + this.domains.push(object) + } else if (object instanceof SubjectController) { + if (this.subjects.some(subject => subject.id === object.id)) + throw new Error(`CacheError: Subject with ID ${object.id} already exists`) + this.subjects.push(object) + } else if (object instanceof LectureController) { + if (this.lectures.some(lecture => lecture.id === object.id)) + throw new Error(`CacheError: Lecture with ID ${object.id} already exists`) + this.lectures.push(object) + } else if (object instanceof LinkController) { + if (this.links.some(link => link.id === object.id)) + throw new Error(`CacheError: Link with ID ${object.id} already exists`) + this.links.push(object) + } else { + throw new Error(`CacheError: Invalid object type: ${object}`) + } + } + + /** + * Removes objects from the cache + * @param object The object to be removed + * @throws `CacheError` If the object does not exist in the cache or if the object type is invalid + */ + + remove(object: UserController): void + remove(object: ProgramController): void + remove(object: CourseController): void + remove(object: GraphController): void + remove(object: DomainController): void + remove(object: SubjectController): void + remove(object: LectureController): void + remove(object: LinkController): void + remove(object: any): void { + if (object instanceof UserController) { + if (!this.users.some(user => user.id === object.id)) + throw new Error(`CacheError: User with ID ${object.id} does not exist`) + this.users = this.users.filter(user => user.id !== object.id) + } else if (object instanceof ProgramController) { + if (!this.programs.some(program => program.id === object.id)) + throw new Error(`CacheError: Program with ID ${object.id} does not exist`) + this.programs = this.programs.filter(program => program.id !== object.id) + } else if (object instanceof CourseController) { + if (!this.courses.some(course => course.id === object.id)) + throw new Error(`CacheError: Course with ID ${object.id} does not exist`) + this.courses = this.courses.filter(course => course.id !== object.id) + } else if (object instanceof GraphController) { + if (!this.graphs.some(graph => graph.id === object.id)) + throw new Error(`CacheError: Graph with ID ${object.id} does not exist`) + this.graphs = this.graphs.filter(graph => graph.id !== object.id) + } else if (object instanceof DomainController) { + if (!this.domains.some(domain => domain.id === object.id)) + throw new Error(`CacheError: Domain with ID ${object.id} does not exist`) + this.domains = this.domains.filter(domain => domain.id !== object.id) + } else if (object instanceof SubjectController) { + if (!this.subjects.some(subject => subject.id === object.id)) + throw new Error(`CacheError: Subject with ID ${object.id} does not exist`) + this.subjects = this.subjects.filter(subject => subject.id !== object.id) + } else if (object instanceof LectureController) { + if (!this.lectures.some(lecture => lecture.id === object.id)) + throw new Error(`CacheError: Lecture with ID ${object.id} does not exist`) + this.lectures = this.lectures.filter(lecture => lecture.id !== object.id) + } else if (object instanceof LinkController) { + if (!this.links.some(link => link.id === object.id)) + throw new Error(`CacheError: Link with ID ${object.id} does not exist`) + this.links = this.links.filter(link => link.id !== object.id) + } else { + throw new Error(`CacheError: Invalid object type: ${object}`) + } + } +} \ No newline at end of file diff --git a/src/lib/scripts/controllers/CourseController.ts b/src/lib/scripts/controllers/CourseController.ts new file mode 100644 index 0000000..fe52ed7 --- /dev/null +++ b/src/lib/scripts/controllers/CourseController.ts @@ -0,0 +1,785 @@ + +// External dependencies +import { browser } from '$app/environment' + +// Internal dependencies +import { ValidationData, Severity } from '$scripts/validation' + +import { + ControllerCache, + ProgramController, + GraphController, + LinkController, + UserController +} from '$scripts/controllers' + +import type { + SerializedProgram, + SerializedCourse, + SerializedGraph, + SerializedLink, + SerializedUser, + DropdownOption +} from '$scripts/types' +import type { Graph } from '@prisma/client' + +// Exports +export { CourseController } + + +// --------------------> Controller + + +class CourseController { + private _programs?: ProgramController[] + private _graphs?: GraphController[] + private _links?: LinkController[] + private _admins?: UserController[] + private _editors?: UserController[] + + private constructor( + public cache: ControllerCache, + public id: number, + public code: string, + public name: string, + private _program_ids: number[], + private _graph_ids: number[], + private _link_ids: number[], + private _editor_ids: number[], + private _admin_ids: number[] + ) { + this.cache.add(this) + } + + // --------------------> Getters & Setters + + get trimmed_code(): string { + return this.code.trim() + } + + get trimmed_name(): string { + return this.name.trim() + } + + get program_ids(): number[] { + return Array.from(this._program_ids) + } + + get graph_ids(): number[] { + return Array.from(this._graph_ids) + } + + get link_ids(): number[] { + return Array.from(this._link_ids) + } + + get admin_ids(): number[] { + return Array.from(this._admin_ids) + } + + get editor_ids(): number[] { + return Array.from(this._editor_ids) + } + + // --------------------> API Getters + + /** + * Gets all courses from the cache or the API + * @returns Array of all courses + * @throws `APIError` if the API call fails + */ + + static async getAll(cache: ControllerCache): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to get all courses + const response = await fetch(`/api/course`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/course GET): ${error}`) + }) + + // Revive the courses + const data = await response.json() as SerializedCourse[] + return data.map(course => CourseController.revive(cache, course)) + } + + /** + * Gets the programs this course is assigned to, from the cache or the API + * @returns Array of programs this course is assigned to + * @throws `APIError` if the API call fails + */ + + async getPrograms(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if programs are already loaded + if (this._programs) { + return Array.from(this._programs) + } + + // Call API to get the course data + const response = await fetch(`/api/course/${this.id}/programs`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/course/${this.id}/programs GET): ${error}`) + }) + + // Revive the programs + const data = await response.json() as SerializedProgram[] + this._programs = data.map(program => ProgramController.revive(this.cache, program)) + + return Array.from(this._programs) + } + + /** + * Gets the graphs assigned to this course, from the cache or the API + * @returns Array of graphs assigned to this course + * @throws `APIError` if the API call fails + */ + + async getGraphs(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if graphs are already loaded + if (this._graphs) { + return Array.from(this._graphs) + } + + // Call API to get the course data + const response = await fetch(`/api/course/${this.id}/graphs`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/course/${this.id}/graphs GET): ${error}`) + }) + + // Revive the graphs + const data = await response.json() as SerializedGraph[] + this._graphs = data.map(graph => GraphController.revive(this.cache, graph)) + + return Array.from(this._graphs) + } + + /** + * Gets the links assigned to this course, from the cache or the API + * @returns Array of links assigned to this course + * @throws `APIError` if the API call fails + */ + + async getLinks(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if links are already loaded + if (this._links) { + return Array.from(this._links) + } + + // Call API to get the course data + const response = await fetch(`/api/course/${this.id}/links`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/course/${this.id}/links GET): ${error}`) + }) + + // Revive the links + const data = await response.json() as SerializedLink[] + this._links = data.map(link => LinkController.revive(this.cache, link)) + + return Array.from(this._links) + } + + /** + * Gets the admins assigned to this course, from the cache or the API + * @returns Array of admins assigned to this course + * @throws `APIError` if the API call fails + */ + + async getAdmins(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if admins are already loaded + if (this._admins) { + return Array.from(this._admins) + } + + // Call API to get the admin data + const response = await fetch(`/api/course/${this.id}/admins`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/course/${this.id}/admins GET): ${error}`) + }) + + // Revive the admins + const data = await response.json() as SerializedUser[] + this._admins = data.map(user => UserController.revive(this.cache, user)) + + return Array.from(this._admins) + } + + /** + * Gets the editors assigned to this course, from the cache or the API + * @returns Array of editors assigned to this course + * @throws `APIError` if the API call fails + */ + + async getEditors(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if editors are already loaded + if (this._editors) { + return Array.from(this._editors) + } + + // Call API to get the editor data + const response = await fetch(`/api/course/${this.id}/editors`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/course/${this.id}/editors GET): ${error}`) + }) + + //Revive the editors + const data = await response.json() as SerializedUser[] + this._editors = data.map(user => UserController.revive(this.cache, user)) + + return Array.from(this._editors) + } + + /** + * Gets the graphs assigned to this course as a list of Dropdown options, from the cache or the API + * @returns Array of Dropdown options for the graphs assigned to this course + */ + + async getGraphOptions(): Promise[]> { + const graphs = await this.getGraphs() + return graphs.map(graph => ({ + value: graph, + label: graph.name, + validation: ValidationData.success() + })) + } + + /** + * Get options for courses a graph can be assigned to + * @returns Array of Dropdown options for courses a graph can be assigned to + */ + + async getCourseOptions(): Promise[]> { + const courses = await CourseController.getAll(this.cache) + return courses.map(course => ({ + value: course, + label: course.trimmed_name, + validation: ValidationData.success() + })) + } + + /** + * Get options for programs a course can be assigned to + * @returns Array of Dropdown options for programs a course can be assigned to + */ + + async getProgramOptions(): Promise[]> { + const programs = await ProgramController.getAll(this.cache) + + return programs.map(program => ({ + value: program, + label: program.trimmed_name, + validation: ValidationData.success() + })) + } + + // --------------------> API actions + + /** + * Creates a new course + * @param cache Cache to create the course with + * @param code Course code + * @param name Course name + * @returns The newly created course controller + * @throws `APIError` if the API call fails + */ + + static async create(cache: ControllerCache, code: string, name: string): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to create a new course + const response = await fetch(`/api/course`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ code, name }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/course POST): ${error}`) + }) + + // Revive the course + const data = await response.json() + return CourseController.revive(cache, data) + } + + /** + * Revives a course from serialized data, or retrieves an existing course from the cache + * @param cache Cache to revive the course with + * @param data Serialized data to revive + * @returns The revived course controller + * @throws `CourseError` if the server data is out of sync with the cache + */ + + static revive(cache: ControllerCache, data: SerializedCourse): CourseController { + const course = cache.find(CourseController, data.id) + if (course) { + if (!course.represents(data)) + throw new Error(`CourseError: Attempted to revive Course with ID ${data.id}, but server data is out of sync with cache`) + return course + } + + return new CourseController( + cache, + data.id, + data.code, + data.name, + data.programs, + data.graphs, + data.links, + data.editors, + data.admins + ) + } + + /** + * Checks if this course contains the same data as a serialized course + * @param data Serialized course to compare against + * @returns Whether this course represents the serialized course + */ + + represents(data: SerializedCourse): boolean { + + // Check the easy stuff + if ( + this.id !== data.id || + this.trimmed_code !== data.code || + this.trimmed_name !== data.name + ) { + return false + } + + // Check programs + if ( + this._program_ids.length !== data.programs.length || + this._program_ids.some(id => !data.programs.includes(id)) || + data.programs.some(id => !this._program_ids.includes(id)) + ) { + return false + } + + // Check graphs + if ( + this._graph_ids.length !== data.graphs.length || + this._graph_ids.some(id => !data.graphs.includes(id)) || + data.graphs.some(id => !this._graph_ids.includes(id)) + ) { + return false + } + + // Check links + if ( + this._link_ids.length !== data.links.length || + this._link_ids.some(id => !data.links.includes(id)) || + data.links.some(id => !this._link_ids.includes(id)) + ) { + return false + } + + // Check editors + if ( + this._editor_ids.length !== data.editors.length || + this._editor_ids.some(id => !data.editors.includes(id)) || + data.editors.some(id => !this._editor_ids.includes(id)) + ) { + return false + } + + // Check admins + if ( + this._admin_ids.length !== data.admins.length || + this._admin_ids.some(id => !data.admins.includes(id)) || + data.admins.some(id => !this._admin_ids.includes(id)) + ) { + return false + } + + return true + } + + /** + * Serializes this course + * @returns Serialized course + */ + + reduce(): SerializedCourse { + return { + id: this.id, + code: this.trimmed_code, + name: this.trimmed_name, + graphs: this._graph_ids, + links: this._link_ids, + admins: this._admin_ids, + editors: this._editor_ids, + programs: this._program_ids + } + } + + /** + * Saves this course + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to save the course + await fetch(`/api/course`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/course PUT): ${error}`) + }) + } + + /** + * Deletes this course, and all related graphs + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Delete all related graphs and links + const graphs = await this.getGraphs() + await Promise.all(graphs.map(graph => graph.delete())) + + const links = await this.getLinks() + await Promise.all(links.map(link => link.delete())) + + // Unassign everywhere (mirroring is not necessary, as this object will be deleted) + for (const id of this._admin_ids) { + this.cache.find(UserController, id) + ?.resignAsCourseAdmin(this, false) + } + + for (const id of this._editor_ids) { + this.cache.find(UserController, id) + ?.resignAsCourseEditor(this, false) + } + + for (const id of this._program_ids) { + this.cache.find(ProgramController, id) + ?.unassignCourse(this, false) + } + + // Call API to delete the course + await fetch(`/api/course/${this.id}`, { method: 'DELETE' }) + .catch(error => { + throw new Error(`APIError (/api/course/${this.id} DELETE): ${error}`) + }) + + // Remove from cache + this.cache.remove(this) + } + + // --------------------> Validation + + /** + * Checks if this course has a name + * @returns Whether this course has a name + */ + + private hasName(): boolean { + return this.trimmed_name !== '' + } + + /** + * Checks if this course has a code + * @returns Whether this course has a code + */ + + private hasCode(): boolean { + return this.trimmed_code !== '' + } + + /** + * Checks if this course has admins + * @returns Whether this course has admins + */ + + private hasAdmins(): boolean { + return this._admin_ids.length > 0 + } + + /** + * Validates this course + * @returns Validation data + */ + + validate(): ValidationData { + const validation = new ValidationData() + + if (!this.hasName()) { + validation.add({ + severity: Severity.error, + short: 'Course has no name' + }) + } + + if (!this.hasCode()) { + validation.add({ + severity: Severity.error, + short: 'Course has no code' + }) + } + + if (!this.hasAdmins()) { + validation.add({ + severity: Severity.warning, + short: 'Course has no admins' + }) + } + + return validation + } + + // --------------------> Assignments + + /** + * Assigns this course to a program + * @param program Target program + * @param mirror Whether to mirror the assignment + */ + + assignProgram(program: ProgramController, mirror: boolean = true): void { + if (this._program_ids.includes(program.id)) return + + // Assign program + this._program_ids.push(program.id) + this._programs?.push(program) + + if (mirror) { + program.assignCourse(this, false) + } + } + + /** + * Assigns a graph to this course + * @param graph Target graph + * @param mirror Whether to mirror the assignment + */ + + assignGraph(graph: GraphController, mirror: boolean = true): void { + if (this._graph_ids.includes(graph.id)) return + + // Assign graph + this._graph_ids.push(graph.id) + this._graphs?.push(graph) + + if (mirror) { + graph.assignCourse(this, false) + } + } + + /** + * Assigns a link to this course + * @param link Target link + * @param mirror Whether to mirror the assignment + */ + + assignLink(link: LinkController, mirror: boolean = true): void { + if (this._link_ids.includes(link.id)) return + + // Assign link + this._link_ids.push(link.id) + this._links?.push(link) + + if (mirror) { + link.assignCourse(this, false) + } + } + + /** + * Assigns a user as an admin of this course. Unassigns the user as an editor if they are one + * @param user Target user + * @param mirror Whether to mirror the assignment + */ + + assignAdmin(user: UserController, mirror: boolean = true): void { + if (this._admin_ids.includes(user.id)) return + + // Unassign as editor + if (this._editor_ids.includes(user.id)) { + this.unassignEditor(user, mirror) + } + + // Assign as admin + this._admin_ids.push(user.id) + this._admins?.push(user) + + if (mirror) { + user.becomeCourseAdmin(this, false) + } + } + + /** + * Assigns a user as an editor of this course. Unassigns the user as an admin if they are one + * @param user Target user + * @param mirror Whether to mirror the assignment + */ + + assignEditor(user: UserController, mirror: boolean = true): void { + if (this._editor_ids.includes(user.id)) return + + // Unassign as admin + if (this._admin_ids.includes(user.id)) { + this.unassignAdmin(user, mirror) + } + + // Assign as editor + this._editor_ids.push(user.id) + this._editors?.push(user) + + if (mirror) { + user.becomeCourseEditor(this, false) + } + } + + /** + * Unassigns this course from a program + * @param program Target program + * @param mirror Whether to mirror the unassignment + */ + + unassignProgram(program: ProgramController, mirror: boolean = true): void { + if (!this._program_ids.includes(program.id)) return + + // Unassign program + this._program_ids = this._program_ids.filter(id => id !== program.id) + this._programs = this._programs?.filter(known => known.id !== program.id) + + if (mirror) { + program.unassignCourse(this, false) + } + } + + /** + * Unassigns a graph from this course + * @param graph Target graph + */ + + unassignGraph(graph: GraphController): void { + if (!this._graph_ids.includes(graph.id)) return + + // Unassign graph + this._graph_ids = this._graph_ids.filter(id => id !== graph.id) + this._graphs = this._graphs?.filter(known => known.id !== graph.id) + } + + /** + * Unassign a link from this course + * @param link Target link + */ + + unassignLink(link: LinkController): void { + if (!this._link_ids.includes(link.id)) return + + // Unassign link + this._link_ids = this._link_ids.filter(id => id !== link.id) + this._links = this._links?.filter(known => known.id !== link.id) + } + + /** + * Unassigns an admin from this course + * @param user Target user + * @param mirror Whether to mirror the unassignment + */ + + unassignAdmin(user: UserController, mirror: boolean = true): void { + if (!this._admin_ids.includes(user.id)) return + + // Unassign admin + this._admin_ids = this._admin_ids.filter(id => id !== user.id) + this._admins = this._admins?.filter(known => known.id !== user.id) + + if (mirror) { + user.resignAsCourseAdmin(this, false) + } + } + + /** + * Unassigns an editor from this course + * @param user Target user + * @param mirror Whether to mirror the unassignment + */ + + unassignEditor(user: UserController, mirror: boolean = true): void { + if (!this._editor_ids.includes(user.id)) return + + // Unassign editor + this._editor_ids = this._editor_ids.filter(id => id !== user.id) + this._editors = this._editors?.filter(known => known.id !== user.id) + + if (mirror) { + user.resignAsCourseEditor(this, false) + } + } + + // --------------------> Utility + + /** + * Checks if this course matches a query + * @param query Query to match against + * @returns Whether this course matches the query + */ + + matchesQuery(query: string): boolean { + query = query.trim().toLowerCase() + if (query === '') return true + + let code = this.code.toLowerCase() + let name = this.name.toLowerCase() + + return code.includes(query) || name.includes(query) + } +} \ No newline at end of file diff --git a/src/lib/scripts/controllers/FieldControllers.ts b/src/lib/scripts/controllers/FieldControllers.ts new file mode 100644 index 0000000..7f63176 --- /dev/null +++ b/src/lib/scripts/controllers/FieldControllers.ts @@ -0,0 +1,1611 @@ + +// External dependencies +import * as uuid from 'uuid' +import { browser } from '$app/environment' + +// Internal dependencies +import { styles } from '$scripts/settings' +import * as settings from '$scripts/settings' +import { ValidationData, Severity } from '$scripts/validation' + +import { + ControllerCache, + GraphController, + LectureController +} from '$scripts/controllers' + +import type { + SerializedGraph, + SerializedDomain, + SerializedSubject +} from '$scripts/types' + +// Exports +export { + FieldController, + DomainController, + SubjectController +} + + +// --------------------> Controllers + + +abstract class FieldController { + protected _graph?: GraphController + protected _parents?: FieldController[] + protected _children?: FieldController[] + + uuid: string + fx?: number + fy?: number + + protected constructor( + public cache: ControllerCache, + public id: number, + public x: number, + public y: number, + public name: string, + protected _graph_id: number, + protected _parent_ids: number[], + protected _child_ids: number[] + ) { + this.uuid = uuid.v4() + } + + // --------------------> Getters & Setters + + get trimmed_name(): string { + return this.name.trim() + } + + get graph_id(): number { + return this._graph_id + } + + get parent_ids(): number[] { + return Array.from(this._parent_ids) + } + + get child_ids(): number[] { + return Array.from(this._child_ids) + } + + // --------------------> API Getters + + /** + * Gets the color of this field + * @returns CSS color string + */ + + async getColor(): Promise { + const style = await this.getStyle() + return style ? styles[style].stroke : 'transparent' + } + + // --------------------> Abstract + + abstract getGraph(): Promise + abstract getParents(): Promise + abstract getChildren(): Promise + abstract getStyle(): Promise + abstract getIndex(): Promise + + abstract represents(data: SerializedDomain | SerializedSubject): boolean + abstract reduce(): SerializedDomain | SerializedSubject + abstract save(): Promise + abstract delete(): Promise + abstract validate(): Promise + + abstract assignGraph(graph: GraphController, mirror?: boolean): void + abstract assignParent(parent: FieldController, mirror?: boolean): void + abstract assignChild(child: FieldController, mirror?: boolean): void + abstract unassignParent(parent: FieldController, mirror?: boolean): void + abstract unassignChild(child: FieldController, mirror?: boolean): void + + abstract matchesQuery(query: string): Promise +} + +class DomainController extends FieldController { + private _subjects?: SubjectController[] + + private constructor( + cache: ControllerCache, + id: number, + x: number, + y: number, + name: string, + public style: string | null, + graph_id: number, + parent_ids: number[], + child_ids: number[], + private _subject_ids: number[] + ) { + super(cache, id, x, y, name, graph_id, parent_ids, child_ids) + this.cache.add(this) + } + + // --------------------> Getters & Setters + + set graph_id(id: number) { + + // Unassign previous graph + this.cache.find(GraphController, this._graph_id) + ?.unassignDomain(this) + + // Assign new graph + this._graph = undefined + this._graph_id = id + + this.cache.find(GraphController, this._graph_id) + ?.assignDomain(this, false) + } + + get subject_ids(): number[] { + return Array.from(this._subject_ids) + } + + // --------------------> API Getters + + /** + * Gets the graph this domain is assigned to, from the cache or the API + * @returns The graph this domain is assigned to + * @throws `APIError` if the API call fails + */ + + async getGraph(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if course is already loaded + if (this._graph) { + return this._graph + } + + // Call API to get the graph data + const response = await fetch(`/api/domain/${this.id}/graph`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/domain/${this.id}/graph GET): ${error}`) + }) + + // Revive the course + const data = await response.json() as SerializedGraph + this._graph = GraphController.revive(this.cache, data) + + return this._graph + } + + /** + * Get the parents of this domain, from the cache or the API + * @returns The parents of this domain + * @throws `APIError` if the API call fails + */ + + async getParents(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if parents are already loaded + if (this._parents) { + return Array.from(this._parents) as DomainController[] + } + + // Call API to get the parent data + const response = await fetch(`/api/domain/${this.id}/parents`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/domain/${this.id}/parents GET): ${error}`) + }) + + // Revive the parents + const data = await response.json() as SerializedDomain[] + this._parents = data.map(parent => DomainController.revive(this.cache, parent)) + + return Array.from(this._parents) as DomainController[] + } + + /** + * Get the children of this domain, from the cache or the API + * @returns The children of this domain + * @throws `APIError` if the API call fails + */ + + async getChildren(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if children are already loaded + if (this._children) { + return Array.from(this._children) as DomainController[] + } + + // Call API to get the child data + const response = await fetch(`/api/domain/${this.id}/children`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/domain/${this.id}/children GET): ${error}`) + }) + + // Revive the children + const data = await response.json() as SerializedDomain[] + this._children = data.map(child => DomainController.revive(this.cache, child)) + + return Array.from(this._children) as DomainController[] + } + + /** + * Get the subjects assigned to this domain, from the cache or the API + * @returns The subjects assigned to this domain + * @throws `APIError` if the API call fails + */ + + async getSubjects(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if subjects are already loaded + if (this._subjects) { + return Array.from(this._subjects) + } + + // Call API to get the subject data + const response = await fetch(`/api/domain/${this.id}/subjects`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/domain/${this.id}/subjects GET): ${error}`) + }) + + // Revive the subjects + const data = await response.json() as SerializedSubject[] + this._subjects = data.map(subject => SubjectController.revive(this.cache, subject)) + + return Array.from(this._subjects) + } + + /** + * Get the style of this domain + * @returns The style of the domain + */ + + async getStyle(): Promise { + return this.style + } + + /** + * Get the style options for this domain + * @returns The style options for the domain + */ + + async getStyleOptions(): Promise<{ value: string, label: string, validation: ValidationData }[]> { + return await Promise.all( + Object.keys(styles).map(async style => { + + // Validate style option + let validation: ValidationData = new ValidationData() + const original = await this.findOriginalStyle(style) + if (original !== -1) { + validation = ValidationData.warning( + 'Style is already in use', + `Style first used by Domain nr. ${original + 1}`, + 1, + this.uuid + ) + } + + // Return style option + return { + value: style, + label: styles[style].display_name, + validation + } + }) + ) + } + + /** + * Get the index of this domain in the graph + * @returns Index of the domain in the graph + */ + + async getIndex(): Promise { + const graph = await this.getGraph() + return graph.domain_ids.indexOf(this.id) + } + + // --------------------> API Actions + + /** + * Create a new domain + * @param cache Cache to create the domain with + * @param graph Graph to assign the domain to + * @returns The newly created DomainController + * @throws `APIError` if the API call fails + */ + + static async create(cache: ControllerCache, graph: GraphController): Promise { + + // Call API to create a new domain + const response = await fetch(`/api/domain`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ graph: graph.id }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/domain POST): ${error}`) + }) + + // Revive the domain + const data = await response.json() + const domain = DomainController.revive(cache, data) + graph.assignDomain(domain) + + return domain + } + + /** + * Revive a domain from serialized data, or retrieve an existing domain from the cache + * @param cache Cache to revive the domain with + * @param data Serialized data to revive + * @returns The revived DomainController + * @throws `DomainError` if the server data is out of sync with the cache + */ + + static revive(cache: ControllerCache, data: SerializedDomain): DomainController { + const existing = cache.find(DomainController, data.id) + if (existing) { + if (!existing.represents(data)) { + throw new Error(`DomainError: Attempted to revive Domain with ID ${data.id}, but server data is out of sync with cache`) + } + } + + return new DomainController(cache, data.id, data.x, data.y, data.name, data.style, data.graph, data.parents, data.children, data.subjects) + } + + /** + * Check if the domain represents the serialized data + * @param data Serialized data to compare against + * @returns Whether the domain represents the serialized data + */ + + represents(data: SerializedDomain): boolean { + + // Check the easy stuff + if ( + this.id !== data.id || + this.x !== data.x || + this.y !== data.y || + this.trimmed_name !== data.name || + this.style !== data.style || + this._graph_id !== data.graph + ) { + return false + } + + // Check parents + if ( + this._parent_ids.length !== data.parents.length || + this._parent_ids.some(id => !data.parents.includes(id)) || + data.parents.some(id => !this._parent_ids.includes(id)) + ) { + return false + } + + // Check children + if ( + this._child_ids.length !== data.children.length || + this._child_ids.some(id => !data.children.includes(id)) || + data.children.some(id => !this._child_ids.includes(id)) + ) { + return false + } + + // Check subjects + if ( + this._subject_ids.length !== data.subjects.length || + this._subject_ids.some(id => !data.subjects.includes(id)) || + data.subjects.some(id => !this._subject_ids.includes(id)) + ) { + return false + } + + return true + } + + /** + * Serialize this domain + * @returns The serialized domain + */ + + reduce(): SerializedDomain { + return { + id: this.id, + x: this.x, + y: this.y, + name: this.trimmed_name, + style: this.style, + graph: this._graph_id, + parents: this._parent_ids, + children: this._child_ids, + subjects: this._subject_ids + } + } + + /** + * Save this domain + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Call API to save the domain + await fetch(`/api/domain`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(await this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/domain PUT): ${error}`) + }) + } + + /** + * Delete this domain + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Call API to delete the domain + await fetch(`/api/domain/${this.id}`, { method: 'DELETE' }) + .catch(error => { + throw new Error(`APIError (/api/domain DELETE): ${error}`) + }) + + // Unassign from graph + const graph = this.cache.find(GraphController, this._graph_id) + ?.unassignDomain(this) + + // Unassign from subjects + for (const id of this._subject_ids) { + const subject = this.cache.find(SubjectController, id) + ?.unassignDomain(false) + } + + // Unassign from prarents + for (const id of this._parent_ids) { + const parent = this.cache.find(DomainController, id) + ?.unassignChild(this, false) + } + + // Unassign from children + for (const id of this._child_ids) { + const child = this.cache.find(DomainController, id) + ?.unassignParent(this, false) + } + + // Remove from cache + this.cache.remove(this) + } + + /** + * Copy this domain to a new graph + * @param target_graph Target graph + * @returns The newly created DomainController + */ + + async copy(target_graph: GraphController): Promise { + const domain_copy = await DomainController.create(this.cache, target_graph) + + domain_copy.name = this.name + domain_copy.style = this.style + domain_copy.x = this.x + domain_copy.y = this.y + domain_copy.fx = this.fx + domain_copy.fy = this.fy + + await domain_copy.save() + return domain_copy + } + + // --------------------> Validation + + /** + * Check if this domain has a name + * @returns Whether the domain has a name + */ + + private hasName(): boolean { + return this.trimmed_name !== '' + } + + /** + * Check if this domain's name is too long + * @returns Whether the domain's name is too long + */ + + private nameTooLong(): boolean { + return this.trimmed_name.length > settings.FIELD_MAX_CHARS + } + + /** + * Find the first occurrence of this domain's name in the graph, ordered by index + * @returns Index of the original name in the graph, or -1 if the name is original/nonexistant + * @throws `DomainError` if the domain is not found in the graph + */ + + private async findOriginalName(): Promise { + if (this.trimmed_name === '') { + return -1 + } + + const graph = await this.getGraph() + const domains = await graph.getDomains() + + for (let index = 0; index < graph.domain_ids.length; index++) { + if (graph.domain_ids[index] === this.id) { + return -1 + } + + const domain = domains.find(domain => domain.id === graph.domain_ids[index]) + if (domain === undefined) throw new Error('DomainError: Domain not found in graph') + if (domain.name === this.trimmed_name) return index + } + + throw new Error('DomainError: Domain not found in graph') + } + + /** + * Check if the domain has a style + * @returns Whether the domain has a style + */ + + private hasStyle(): boolean { + return this.style !== null + } + + /** + * Find the first occurrence of a style in the graph, ordered by index + * @param style Style to find + * @returns Index of the original style in the graph, or -1 if the style is original/nonexistant + */ + + private async findOriginalStyle(style: string): Promise { + const graph = await this.getGraph() + const domains = await graph.getDomains() + + for (let index = 0; index < graph.domain_ids.length; index++) { + if (graph.domain_ids[index] === this.id) { + return -1 + } + + const domain = domains.find(domain => domain.id === graph.domain_ids[index]) + if (domain === undefined) throw new Error('DomainError: Domain not found in graph') + + const domain_style = await domain.getStyle() + if (domain_style === style) return index + } + + throw new Error('DomainError: Domain not found in graph') + } + + /** + * Check if the domain has subjects + * @returns Whether the domain has subjects + */ + + private hasSubjects(): boolean { + return this._subject_ids.length > 0 + } + + /** + * Validate this domain + * @returns Validation data + */ + + async validate(): Promise { + const validation = new ValidationData() + + if (!this.hasName()) { + validation.add({ + severity: Severity.error, + short: 'Domain has no name', + tab: 1, + uuid: this.uuid + }) + } + + else { + const original = await this.findOriginalName() + if (original !== -1) { + validation.add({ + severity: Severity.warning, + short: 'Domain name is already in use', + long: `Name first used by Domain nr. ${original + 1}`, + tab: 1, + uuid: this.uuid + }) + } + + if (this.nameTooLong()) { + validation.add({ + severity: Severity.error, + short: 'Domain name is too long', + long: `Name exceeds ${settings.FIELD_MAX_CHARS} characters`, + tab: 1, + uuid: this.uuid + }) + } + } + + if (!this.hasStyle()) { + validation.add({ + severity: Severity.error, + short: 'Domain has no style', + tab: 1, + uuid: this.uuid + }) + } + + else { + + const original = await this.findOriginalStyle(this.style!) + if (original !== -1) { + validation.add({ + severity: Severity.warning, + short: 'Domain style is already in use', + long: `Style first used by Domain nr. ${original + 1}`, + tab: 1, + uuid: this.uuid + }) + } + } + + if (!this.hasSubjects()) { + validation.add({ + severity: Severity.warning, + short: 'Domain has no subjects', + tab: 1, + uuid: this.uuid + }) + } + + return validation + } + + // --------------------> Assignments + + /** + * Assign a graph to this domain + * @param graph Target graph + * @param mirror Whether to mirror the assignment + */ + + assignGraph(graph: GraphController, mirror: boolean = true): void { + if (this._graph_id === graph.id) return + + // Unassign previous graph + if (this._graph_id && mirror) { + this.cache.find(GraphController, this._graph_id) + ?.unassignDomain(this) + } + + // Assign new graph + this._graph_id = graph.id + this._graph = graph + + if (mirror) { + graph.assignDomain(this, false) + } + } + + /** + * Assign a parent to this domain + * @param parent Target parent + * @param mirror Whether to mirror the assignment + */ + + assignParent(parent: DomainController, mirror: boolean = true): void { + if (this._parent_ids.includes(parent.id)) return + + // Assign parent + this._parent_ids.push(parent.id) + this._parents?.push(parent) + + if (mirror) { + parent.assignChild(this, false) + + // Create relation + this.cache.find(GraphController, this._graph_id) + ?.createDomainRelation(parent, this, false) + } + } + + /** + * Assign a child to this domain + * @param child Target child + * @param mirror Whether to mirror the assignment + */ + + assignChild(child: DomainController, mirror: boolean = true): void { + if (this._child_ids.includes(child.id)) return + + // Assign child + this._child_ids.push(child.id) + this._children?.push(child) + + if (mirror) { + child.assignParent(this, false) + + // Create relation + this.cache.find(GraphController, this._graph_id) + ?.createDomainRelation(this, child, false) + } + } + + /** + * Assign a subject to this domain + * @param subject Target subject + * @param mirror Whether to mirror the assignment + */ + + assignSubject(subject: SubjectController, mirror: boolean = true): void { + if (this._subject_ids.includes(subject.id)) return + + // Assign subject + this._subject_ids.push(subject.id) + this._subjects?.push(subject) + + if (mirror) { + subject.assignDomain(this, false) + } + } + + /** + * Unassign a parent from this domain + * @param parent Target parent + * @param mirror Whether to mirror the unassignment + */ + + unassignParent(parent: DomainController, mirror: boolean = true): void { + if (!this._parent_ids.includes(parent.id)) return + + // Unassign parent + this._parent_ids = this._parent_ids.filter(id => id !== parent.id) + this._parents = this._parents?.filter(known => known.id !== parent.id) + + if (mirror) { + parent.unassignChild(this, false) + + // Delete relation + this.cache.find(GraphController, this._graph_id) + ?.deleteDomainRelation(parent, this, false) + } + } + + /** + * Unassign a child from this domain + * @param child Target child + * @param mirror Whether to mirror the unassignment + */ + + unassignChild(child: DomainController, mirror: boolean = true): void { + if (!this._child_ids.includes(child.id)) return + + // Unassign child + this._child_ids = this._child_ids.filter(id => id !== child.id) + this._children = this._children?.filter(known => known.id !== child.id) + + if (mirror) { + child.unassignParent(this, false) + + // Delete relation + this.cache.find(GraphController, this._graph_id) + ?.deleteDomainRelation(this, child, false) + } + } + + /** + * Unassign a subject from this domain + * @param subject Target subject + * @param mirror Whether to mirror the unassignment + */ + + unassignSubject(subject: SubjectController, mirror: boolean = true): void { + if (!this._subject_ids.includes(subject.id)) return + + // Unassign subject + this._subject_ids = this._subject_ids.filter(id => id !== subject.id) + this._subjects = this._subjects?.filter(known => known.id !== subject.id) + + if (mirror) { + subject.unassignDomain(false) + } + } + + // --------------------> Utility + + /** + * Check if this domain matches a query + * @param query Query to match + * @returns Whether the domain matches the query + */ + + async matchesQuery(query: string): Promise { + const query_lower = query.toLowerCase() + const name = this.trimmed_name.toLowerCase() + const style = this.style ? styles[this.style].display_name.toLowerCase() : '' + + return name.includes(query_lower) || style.includes(query_lower) + } +} + +class SubjectController extends FieldController { + private _domain?: DomainController | null + private _lectures?: LectureController[] + + private constructor( + cache: ControllerCache, + id: number, + x: number, + y: number, + name: string, + private _domain_id: number | null, + graph_id: number, + parent_ids: number[], + child_ids: number[], + private _lecture_ids: number[] + ) { + super(cache, id, x, y, name, graph_id, parent_ids, child_ids) + this.cache.add(this) + } + + // --------------------> Getters & Setters + + set graph_id(id: number) { + + // Unassign previous graph + this.cache.find(GraphController, this._graph_id) + ?.unassignSubject(this) + + // Assign new graph + this._graph = undefined + this._graph_id = id + + this.cache.find(GraphController, this._graph_id) + ?.assignSubject(this, false) + } + + get domain_id(): number | null { + return this._domain_id + } + + set domain_id(id: number | null) { + + // Unassign previous domain + if (this._domain_id) { + this.cache.find(DomainController, this._domain_id) + ?.unassignSubject(this) + } + + // Assign new domain + this._domain = undefined + this._domain_id = id + + if (this._domain_id) { + this.cache.find(DomainController, this._domain_id) + ?.assignSubject(this, false) + } + } + + get lecture_ids(): number[] { + return Array.from(this._lecture_ids) + } + + // --------------------> API Getters + + /** + * Get the graph this subject is assigned to, from the cache or the API + * @returns The graph this subject is assigned to + */ + + async getGraph(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if course is already loaded + if (this._graph) { + return this._graph + } + + // Call API to get the graph data + const response = await fetch(`/api/subject/${this.id}/course`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/subject/${this.id}/course GET): ${error}`) + }) + + // Revive the course + const data = await response.json() as SerializedGraph + this._graph = GraphController.revive(this.cache, data) + + return this._graph + } + + /** + * Get the domain this subject is assigned to, from the cache or the API + * @returns The domain this subject is assigned to + */ + + async getDomain(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if domain is already loaded + if (this._domain) { + return this._domain + } + + // Call API to get the domain data + const response = await fetch(`/api/subject/${this.id}/domain`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/subject/${this.id}/domain GET): ${error}`) + }) + + // Revive the domain + const data = await response.json() as SerializedDomain + this._domain = data ? DomainController.revive(this.cache, data) : null + + return this._domain + } + + /** + * Get the lectures assigned to this subject, from the cache or the API + * @returns The lectures assigned to this subject + * @throws `APIError` if the API call fails + */ + + async getLectures(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if lectures are already loaded + if (this._lectures) { + return Array.from(this._lectures) + } + + // Call API to get the lecture data + const response = await fetch(`/api/subject/${this.id}/lectures`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/subject/${this.id}/lectures GET): ${error}`) + }) + + // Revive the lectures + const data = await response.json() as SerializedDomain[] + this._lectures = data.map(lecture => LectureController.revive(this.cache, lecture)) + + return Array.from(this._lectures) + } + + /** + * Get the parents of this subject, from the cache or the API + * @returns The parents of the subject + * @throws `APIError` if the API call fails + */ + + async getParents(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if parents are already loaded + if (this._parents) { + return Array.from(this._parents) as SubjectController[] + } + + // Call API to get the parent data + const response = await fetch(`/api/subject/${this.id}/parents`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/subject/${this.id}/parents GET): ${error}`) + }) + + // Revive the parents + const data = await response.json() as SerializedSubject[] + this._parents = data.map(parent => SubjectController.revive(this.cache, parent)) + + return Array.from(this._parents) as SubjectController[] + } + + /** + * Get the children of this subject + * @returns The children of this subject + * @throws `APIError` if the API call fails + */ + + async getChildren(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if children are already loaded + if (this._children) { + return Array.from(this._children) as SubjectController[] + } + + // Call API to get the child data + const response = await fetch(`/api/subject/${this.id}/children`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/subject/${this.id}/children GET): ${error}`) + }) + + // Revive the children + const data = await response.json() as SerializedSubject[] + this._children = data.map(child => SubjectController.revive(this.cache, child)) + + return Array.from(this._children) as SubjectController[] + } + + /** + * Get the style of this subject + * @returns The style of this subject + */ + + async getStyle(): Promise { + const domain = await this.getDomain() + return domain ? domain.getStyle() : null + } + + /** + * Get the index of this subject in the graph + * @returns Index of this subject in the graph + */ + + async getIndex(): Promise { + const graph = await this.getGraph() + return graph.subject_ids.indexOf(this.id) + } + + // --------------------> API Actions + + /** + * Create a new subject + * @param cache Cache to create the subject with + * @param graph Graph to assign the subject to + * @returns The newly created SubjectController + * @throws `APIError` if the API call fails + */ + + static async create(cache: ControllerCache, graph: GraphController): Promise { + + // Call API to create a new subject + const response = await fetch(`/api/subject`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ graph: graph.id }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/subject POST): ${error}`) + }) + + // Revive the subject + const data = await response.json() + const subject = SubjectController.revive(cache, data) + graph.assignSubject(subject) + + return subject + } + + /** + * Revive a subject from serialized data, or retrieve an existing subject from the cache + * @param cache Cache to revive the subject with + * @param data Serialized data to revive + * @returns The revived SubjectController + * @throws `SubjectError` if the server data is out of sync with the cache + */ + + static revive(cache: ControllerCache, data: SerializedSubject): SubjectController { + const existing = cache.find(SubjectController, data.id) + if (existing) { + if (!existing.represents(data)) + throw new Error(`SubjectError: Attempted to revive Subject with ID ${data.id}, but server data is out of sync with cache`) + return existing + } + + return new SubjectController(cache, data.id, data.x, data.y, data.name, data.domain, data.graph, data.parents, data.children, data.lectures) + } + + /** + * Serialize this subject + * @returns Serialized subject + */ + + reduce(): SerializedSubject { + return { + id: this.id, + x: this.x, + y: this.y, + name: this.trimmed_name, + domain: this._domain_id, + graph: this._graph_id, + parents: this._parent_ids, + children: this._child_ids, + lectures: this._lecture_ids + } + } + + /** + * Check if the subject represents the serialized data + * @param data Serialized data to compare against + * @returns Whether the subject represents the serialized data + */ + + represents(data: SerializedSubject): boolean { + + // Check the easy stuff + if ( + this.id !== data.id || + this.x !== data.x || + this.y !== data.y || + this.trimmed_name !== data.name || + this._domain_id !== data.domain || + this._graph_id !== data.graph + ) { + return false + } + + // Check parents + if ( + this._parent_ids.length !== data.parents.length || + this._parent_ids.some(id => !data.parents.includes(id)) || + data.parents.some(id => !this._parent_ids.includes(id)) + ) { + return false + } + + // Check children + if ( + this._child_ids.length !== data.children.length || + this._child_ids.some(id => !data.children.includes(id)) || + data.children.some(id => !this._child_ids.includes(id)) + ) { + return false + } + + // Check lectures + if ( + this._lecture_ids.length !== data.lectures.length || + this._lecture_ids.some(id => !data.lectures.includes(id)) || + data.lectures.some(id => !this._lecture_ids.includes(id)) + ) { + return false + } + + return true + } + + /** + * Save this subject + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Call API to save the subject + await fetch(`/api/subject`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/subject PUT): ${error}`) + }) + } + + /** + * Delete this subject + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Call API to delete the subject + await fetch(`/api/subject/${this.id}`, { method: 'DELETE' }) + .catch(error => { + throw new Error(`APIError (/api/subject/${this.id} DELETE): ${error}`) + }) + + // Unassign from graph + this.cache.find(GraphController, this._graph_id) + ?.unassignSubject(this) + + // Unassign from domain + if (this._domain_id) { + this.cache.find(DomainController, this._domain_id) + ?.unassignSubject(this, false) + } + + // Unassign from parents + for (const id of this._parent_ids) { + this.cache.find(SubjectController, id) + ?.unassignChild(this, false) + } + + // Unassign from children + for (const id of this._child_ids) { + this.cache.find(SubjectController, id) + ?.unassignParent(this, false) + } + + // Unassign from lectures + for (const id of this._lecture_ids) { + this.cache.find(LectureController, id) + ?.unassignSubject(this, false) + } + + // Remove from cache + this.cache.remove(this) + } + + /** + * Copy this subject to a new graph + * @param target_graph Target graph + * @returns The newly created SubjectController + */ + + async copy(target_graph: GraphController): Promise { + const subject_copy = await SubjectController.create(this.cache, target_graph) + + subject_copy.name = this.name + subject_copy.x = this.x + subject_copy.y = this.y + subject_copy.fx = this.fx + subject_copy.fy = this.fy + + await subject_copy.save() + return subject_copy + } + + // --------------------> Validation + + /** + * Check if this subject has a name + * @returns Whether the subject has a name + */ + + private hasName(): boolean { + return this.trimmed_name !== '' + } + + /** + * Check if this subjects's name is too long + * @returns Whether the subject's name is too long + */ + + private nameTooLong(): boolean { + return this.trimmed_name.length > settings.FIELD_MAX_CHARS + } + + /** + * Find the first occurrence of this subjects's name in the graph, ordered by index + * @returns Index of the original name in the graph, or -1 if the name is original/nonexistant + * @throws `SubjectError` if the subject is not found in the graph + */ + + private async findOriginalName(): Promise { + if (this.trimmed_name === '') { + return -1 + } + + const graph = await this.getGraph() + const subjects = await graph.getSubjects() + + for (let index = 0; index < graph.subject_ids.length; index++) { + if (graph.subject_ids[index] === this.id) { + return -1 + } + + const subject = subjects.find(subject => subject.id === graph.subject_ids[index]) + if (subject === undefined) throw new Error('SubjectError: Subject not found in graph') + if (subject.name === this.trimmed_name) return index + } + + throw new Error('SubjectError: Subject not found in graph') + } + + /** + * Check if the subject has a domain + * @returns Whether the subject has a domain + */ + + private hasDomain(): boolean { + return this._domain_id !== null + } + + /** + * Validate this subject + * @returns Validation data + */ + + async validate(): Promise { + const validation = new ValidationData() + + if (!this.hasName()) { + validation.add({ + severity: Severity.error, + short: 'Subject has no name', + tab: 2, + uuid: this.uuid + }) + } + + else { + const original = await this.findOriginalName() + if (original !== -1) { + validation.add({ + severity: Severity.warning, + short: 'Subject name is already in use', + long: `Name first used by Subject nr. ${original + 1}`, + tab: 2, + uuid: this.uuid + }) + } + + if (this.nameTooLong()) { + validation.add({ + severity: Severity.error, + short: 'Subject name is too long', + long: `Name exceeds ${settings.FIELD_MAX_CHARS} characters`, + tab: 2, + uuid: this.uuid + }) + } + } + + if (!this.hasDomain()) { + validation.add({ + severity: Severity.error, + short: 'Subject has no domain', + tab: 2, + uuid: this.uuid + }) + } + + return validation + } + + // --------------------> Assignments + + /** + * Assign a graph to this subject + * @param graph Target graph + * @param mirror Whether to mirror the assignment + */ + + assignGraph(graph: GraphController, mirror: boolean = true): void { + if (this._graph_id === graph.id) return + + // Unassign previous graph + if (this._graph_id && mirror) { + this.cache.find(GraphController, this._graph_id) + ?.unassignSubject(this) + } + + // Assign new graph + this._graph_id = graph.id + this._graph = graph + + if (mirror) { + graph.assignSubject(this, false) + } + } + + /** + * Assign a domain to this subject + * @param domain Target domain + * @param mirror Whether to mirror the assignment + */ + + assignDomain(domain: DomainController, mirror: boolean = true): void { + if (this._domain_id === domain.id) return + + // Unassign previous domain + if (mirror && this._domain_id) { + this.cache.find(DomainController, this._domain_id) + ?.unassignSubject(this, false) + } + + // Assign new domain + this._domain_id = domain.id + this._domain = domain + + if (mirror) { + domain.assignSubject(this, false) + } + } + + /** + * Assign a parent to this subject + * @param parent Target parent + * @param mirror Whether to mirror the assignment + */ + + assignParent(parent: SubjectController, mirror: boolean = true): void { + if (this._parent_ids.includes(parent.id)) return + + // Assign parent + this._parent_ids.push(parent.id) + this._parents?.push(parent) + + if (mirror) { + parent.assignChild(this, false) + + // Create relation + this.cache.find(GraphController, this._graph_id) + ?.createSubjectRelation(parent, this, false) + } + } + + /** + * Assign a child to this subject + * @param child Target child + * @param mirror Whether to mirror the assignment + */ + + assignChild(child: SubjectController, mirror: boolean = true): void { + if (this._child_ids.includes(child.id)) return + + // Assign child + this._child_ids.push(child.id) + this._children?.push(child) + + if (mirror) { + child.assignParent(this, false) + + // Create relation + this.cache.find(GraphController, this._graph_id) + ?.createSubjectRelation(this, child, false) + } + } + + /** + * Assign a lecture to this subject + * @param lecture Target lecture + * @param mirror Whether to mirror the assignment + */ + + assignLecture(lecture: LectureController, mirror: boolean = true): void { + if (this._lecture_ids.includes(lecture.id)) return + + // Assign lecture + this._lecture_ids.push(lecture.id) + this._lectures?.push(lecture) + + if (mirror) { + lecture.assignSubject(this, false) + } + } + + /** + * Unassign a domain from this subject + * @param mirror Whether to mirror the unassignment + */ + + unassignDomain(mirror: boolean = true): void { + if (!this._domain_id) return + + // Unassign domain + if (mirror && this._domain_id) { + this.cache.find(DomainController, this._domain_id) + ?.unassignSubject(this, false) + } + + this._domain_id = null + this._domain = null + } + + /** + * Unassign a parent from this subject + * @param parent Target parent + * @param mirror Whether to mirror the unassignment + */ + + unassignParent(parent: SubjectController, mirror: boolean = true): void { + if (!this._parent_ids.includes(parent.id)) return + + // Unassign parent + this._parent_ids = this._parent_ids.filter(id => id !== parent.id) + this._parents = this._parents?.filter(known => known.id !== parent.id) + + if (mirror) { + parent.unassignChild(this, false) + + // Delete relation + this.cache.find(GraphController, this._graph_id) + ?.deleteSubjectRelation(parent, this, false) + } + } + + /** + * Unassign a child from this subject + * @param child Target child + * @param mirror Whether to mirror the unassignment + */ + + unassignChild(child: SubjectController, mirror: boolean = true): void { + if (!this._child_ids.includes(child.id)) return + + // Unassign child + this._child_ids = this._child_ids.filter(id => id !== child.id) + this._children = this._children?.filter(known => known.id !== child.id) + + if (mirror) { + child.unassignParent(this, false) + + // Delete relation + this.cache.find(GraphController, this._graph_id) + ?.deleteSubjectRelation(this, child, false) + } + } + + /** + * Unassign a lecture from this subject + * @param lecture Target lecture + * @param mirror Whether to mirror the unassignment + */ + + unassignLecture(lecture: LectureController, mirror: boolean = true): void { + if (!this._lecture_ids.includes(lecture.id)) return + + // Unassign lecture + this._lecture_ids = this._lecture_ids.filter(id => id !== lecture.id) + this._lectures = this._lectures?.filter(known => known.id !== lecture.id) + + if (mirror) { + lecture.unassignSubject(this, false) + } + } + + // --------------------> Utility + + /** + * Check if this subject matches a query + * @param query Query to match + * @returns Whether the subject matches the query + */ + + async matchesQuery(query: string): Promise { + const query_lower = query.toLowerCase() + const name = this.trimmed_name.toLowerCase() + const domain = await this.getDomain().then(domain => domain?.name.toLowerCase() || '') + + return name.includes(query_lower) || domain.includes(query_lower) + } +} \ No newline at end of file diff --git a/src/lib/scripts/controllers/GraphController.ts b/src/lib/scripts/controllers/GraphController.ts new file mode 100644 index 0000000..e1aab11 --- /dev/null +++ b/src/lib/scripts/controllers/GraphController.ts @@ -0,0 +1,1087 @@ + +// External dependencies +import { browser } from '$app/environment' + +// Internal dependencies +import { ValidationData, Severity } from '$scripts/validation' + +import { + ControllerCache, + CourseController, + DomainController, + DomainRelationController, + SubjectController, + SubjectRelationController, + LectureController, + LinkController +} from '$scripts/controllers' + +import type { + SerializedGraph, + SerializedDomain, + SerializedCourse, + SerializedSubject, + SerializedLecture, + SerializedLink, + DropdownOption +} from '$scripts/types' + +// Exports +export { GraphController, SortOption } + + +// --------------------> Enums + + +enum SortOption { + ascending = 0b1000000000, + descending = 0b0100000000, + relations = 0b0010000000, + subjects = 0b0001000000, + domains = 0b0000100000, + index = 0b0000010000, + name = 0b0000001000, + style = 0b0000000100, + parents = 0b0000000010, + children = 0b0000000001 +} + + +// --------------------> Controller + + +class GraphController { + private _course?: CourseController + private _domains?: DomainController[] + private _domain_relations?: DomainRelationController[] + private _subjects?: SubjectController[] + private _subject_relations?: SubjectRelationController[] + private _lectures?: LectureController[] + private _links?: LinkController[] + + private constructor( + public cache: ControllerCache, + public id: number, + public name: string, + private _course_id: number, + private _domain_ids: number[], + private _subject_ids: number[], + private _lecture_ids: number[], + private _links_ids: number[] + ) { + this.cache.add(this) + } + + // --------------------> Getters & Setters + + get trimmed_name(): string { + return this.name.trim() + } + + get course_id(): number { + return this._course_id + } + + set course_id(id: number) { + + // Unassign previous course + this.cache.find(CourseController, this._course_id) + ?.unassignGraph(this) + + // Assign new course + this._course = undefined + this._course_id = id + + this.cache.find(CourseController, this._course_id) + ?.assignGraph(this, false) + } + + get domain_ids(): number[] { + return this._domain_ids.concat() + } + + get subject_ids(): number[] { + return this._subject_ids.concat() + } + + get lecture_ids(): number[] { + return this._lecture_ids.concat() + } + + get link_ids(): number[] { + return this._links_ids.concat() + } + + // --------------------> API Getters + + /** + * Get the course this graph is assigned to, from the cache or the API + * @returns The course this graph is assigned to + * @throws `APIError` if the API call fails + */ + + async getCourse(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if course is already loaded + if (this._course) { + return this._course + } + + // Call API to get the course data + const response = await fetch(`/api/graph/${this.id}/course`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/graph/${this.id}/course GET): ${error}`) + }) + + // Revive the course + const data = await response.json() as SerializedCourse + this._course = CourseController.revive(this.cache, data) + + return this._course + } + + /** + * Get the domains assigned to this graph, from the cache or the API + * @returns The domains assigned to this graph + * @throws `APIError` if the API call fails + */ + + async getDomains(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if domains are already loaded + if (this._domains) { + return Array.from(this._domains) + } + + // Call API to get the domain data + const response = await fetch(`/api/graph/${this.id}/domains`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/graph/${this.id}/domains GET): ${error}`) + }) + + // Revive the domains + const data = await response.json() as SerializedDomain[] + this._domains = data.map(domain => DomainController.revive(this.cache, domain)) + + return Array.from(this._domains) + } + + /** + * Infer the domain relations from the domains assigned to this graph + * @returns The domain relations + */ + + async getDomainRelations(): Promise { + + // Check if domain relations are already loaded + if (this._domain_relations) { + return Array.from(this._domain_relations) + } + + // Infer relations + this._domain_relations = [] + const domains = await this.getDomains() + for (const domain of domains) { + const children = await domain.getChildren() + for (const child of children) { + this.createDomainRelation(domain, child, false) + } + } + + return Array.from(this._domain_relations) + } + + /** + * Get the subjects assigned to this graph, from the cache or the API + * @returns The subjects assigned to this graph + * @throws `APIError` if the API call fails + */ + + async getSubjects(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if subjects are already loaded + if (this._subjects) { + return Array.from(this._subjects) + } + + // Call API to get the subject data + const response = await fetch(`/api/graph/${this.id}/subjects`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/graph/${this.id}/subjects GET): ${error}`) + }) + + // Revive the subjects + const data = await response.json() as SerializedSubject[] + this._subjects = data.map(subject => SubjectController.revive(this.cache, subject)) + + return Array.from(this._subjects) + } + + /** + * Infer the subject relations from the subjects assigned to this graph + * @returns The subject relations + */ + + async getSubjectRelations(): Promise { + + // Check if subject relations are already loaded + if (this._subject_relations) { + return Array.from(this._subject_relations) + } + + // Infer relations + this._subject_relations = [] + const subjects = await this.getSubjects() + for (const parent of subjects) { + const children = await parent.getChildren() + for (const child of children) { + this.createSubjectRelation(parent, child, false) + } + } + + return Array.from(this._subject_relations) + } + + /** + * Get the lectures assigned to this graph, from the cache or the API + * @returns The lectures assigned to this graph + * @throws `APIError` if the API call fails + */ + + async getLectures(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if lectures are already loaded + if (this._lectures) { + return Array.from(this._lectures) + } + + // Call API to get the lectures + const response = await fetch(`/api/graph/${this.id}/lectures`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/graph/${this.id}/lectures GET): ${error}`) + }) + + // Parse the data + const data = await response.json() as SerializedLecture[] + this._lectures = data.map(lecture => LectureController.revive(this.cache, lecture)) + + return Array.from(this._lectures) + } + + /** + * Get the links assigned to this graph, from the cache or the API + * @returns The links assigned to this graph + * @throws `APIError` if the API call fails + */ + + async getLinks(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if links are already loaded + if (this._links) { + return Array.from(this._links) + } + + // Call API to get the link data + const response = await fetch(`/api/graph/${this.id}/links`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/graph/${this.id}/links GET): ${error}`) + }) + + // Revive the links + const data = await response.json() as SerializedLink[] + this._links = data.map(link => LinkController.revive(this.cache, link)) + + return Array.from(this._links) + } + + // --------------------> API actions + + /** + * Create a new graph + * @param cache Cache to create the graph with + * @param course_id Course to assign the graph to + * @returns The newly created GraphController + * @throws `APIError` if the API call fails + */ + + static async create(cache: ControllerCache, course_id: number, name: string): Promise { + + // Guard against SSR + if (!browser) { + Promise.reject() + } + + // Call API to create a new graph + const response = await fetch(`/api/graph`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ course: course_id, name }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/graph POST): ${error}`) + }) + + // Revive the graph + const data = await response.json() + const graph = GraphController.revive(cache, data) + + // Assign to course + cache.find(CourseController, course_id) + ?.assignGraph(graph) + + return graph + } + + /** + * Revive a graph from serialized data + * @param cache Cache to revive the graph with + * @param data Serialized data to revive + * @returns `GraphController` The revived GraphController + * @throws `GraphError` if the server data is out of sync with the cache + */ + + static revive(cache: ControllerCache, data: SerializedGraph): GraphController { + const graph = cache.find(GraphController, data.id) + if (graph) { + if (!graph.represents(data)) + throw new Error(`GraphError: Attempted to revive Graph with ID ${data.id}, but server data is out of sync with cache`) + return graph + } + + return new GraphController( + cache, + data.id, + data.name, + data.course, + data.domains, + data.subjects, + data.lectures, + data.links + ) + } + + /** + * Check if this graph represents the serialized data + * @param data Serialized data to compare against + * @returns Whether this graph represents the serialized data + */ + + represents(data: SerializedGraph): boolean { + + // Check the easy stuff + if ( + this.id !== data.id || + this.trimmed_name !== data.name || + this.course_id !== data.course + ) { + return false + } + + // Check domains + if ( + this.domain_ids.length !== data.domains.length || + this.domain_ids.some(id => !data.domains.includes(id)) || + data.domains.some(id => !this.domain_ids.includes(id)) + ) { + return false + } + + // Check subjects + if ( + this.subject_ids.length !== data.subjects.length || + this.subject_ids.some(id => !data.subjects.includes(id)) || + data.subjects.some(id => !this.subject_ids.includes(id)) + ) { + return false + } + + // Check lectures + if ( + this.lecture_ids.length !== data.lectures.length || + this.lecture_ids.some(id => !data.lectures.includes(id)) || + data.lectures.some(id => !this.lecture_ids.includes(id)) + ) { + return false + } + + // Check links + if ( + this.link_ids.length !== data.links.length || + this.link_ids.some(id => !data.links.includes(id)) || + data.links.some(id => !this.link_ids.includes(id)) + ) { + return false + } + + return true + } + + /** + * Serialize this graph + * @returns Serialized graph + */ + + reduce(): SerializedGraph { + return { + id: this.id, + name: this.trimmed_name, + course: this.course_id, + domains: this.domain_ids, + subjects: this.subject_ids, + lectures: this.lecture_ids, + links: this.link_ids + } + } + + /** + * Save this graph + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to save the graph + await fetch(`/api/graph`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/graph PUT): ${error}`) + }) + } + + /** + * Delete this graph, and all related domains, subjects, and lectures + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Unassign from course and links + this.cache.find(CourseController, this.course_id) + ?.unassignGraph(this) + + for (const id of this.link_ids) { + this.cache.find(LinkController, id) + ?.unassignGraph(false) + } + + // Delete all related domains, subjects, and lectures + const domains = await this.getDomains() + await Promise.all(domains.map(domain => domain.delete())) + + const subjects = await this.getSubjects() + await Promise.all(subjects.map(subject => subject.delete())) + + const lectures = await this.getLectures() + await Promise.all(lectures.map(lecture => lecture.delete())) + + // Call API to delete the graph + await fetch(`/api/graph/${this.id}`, { method: 'DELETE' }) + .catch(error => { + throw new Error(`APIError (/api/graph/${this.id} DELETE): ${error}`) + }) + + // Remove from cache + this.cache.remove(this) + } + + /** + * Copy this graph and all its members to another course + */ + + async copy(target_course: CourseController): Promise { + const course = await this.getCourse() + + // Copy the graph + const graph_copy = await GraphController.create(this.cache, target_course.id, this.name) + graph_copy.name = `${this.name} (Copied from ${course.code})` + + // Copy domains + const domain_map = new Map() + const domains = await this.getDomains() + for (const domain of domains) { + const domain_copy = await domain.copy(graph_copy) + domain_map.set(domain.id, domain_copy) + } + + // Copy domain relations + const domain_relations = await this.getDomainRelations() + for (const relation of domain_relations) { + + // Find the parent and child in the map + if (!relation.parent || !relation.child) continue + const parent_copy = domain_map.get(relation.parent.id) + const child_copy = domain_map.get(relation.child.id) + + // Create the relation + if (!parent_copy || !child_copy) throw new Error('GraphError: Domain not found in map') + await graph_copy.createDomainRelation(parent_copy, child_copy) + } + + // Copy subjects + const subject_map = new Map() + const subjects = await this.getSubjects() + for (const subject of subjects) { + const subject_copy = await subject.copy(graph_copy) + subject_map.set(subject.id, subject_copy) + + // Assign the copied domain to the copied subject + if (!subject.domain_id) continue + const domain_copy = domain_map.get(subject.domain_id) + if (!domain_copy) throw new Error('GraphError: Domain not found in map') + subject_copy.assignDomain(domain_copy) + + } + + // Copy subject relations + const subject_relations = await this.getSubjectRelations() + for (const relation of subject_relations) { + + // Find the parent and child in the map + if (!relation.parent || !relation.child) continue + const parent_copy = subject_map.get(relation.parent.id) + const child_copy = subject_map.get(relation.child.id) + + // Create the relation + if (!parent_copy || !child_copy) throw new Error('GraphError: Subject not found in map') + await graph_copy.createSubjectRelation(parent_copy, child_copy) + } + + // Copy lectures + const lectures = await this.getLectures() + for (const lecture of lectures) { + const lecture_copy = await lecture.copy(graph_copy) + + // Assign the copied subjects to the copied lecture + const subjects = await lecture.getSubjects() + for (const subject of subjects) { + const subject_copy = subject_map.get(subject.id) + if (!subject_copy) throw new Error('GraphError: Subject not found in map') + lecture_copy.assignSubject(subject_copy) + } + } + + await graph_copy.save() + return graph_copy + } + + // --------------------> Validation + + /** + * Check if this graph has a name + * @returns Whether this graph has a name + */ + + private hasName(): boolean { + return this.trimmed_name !== '' + } + + /** + * Check if this graph has a duplicate name + * @returns Whether this graph has a duplicate name + */ + + private async duplicateName(): Promise { + const graphs = await this.getCourse() + .then(course => course.getGraphs()) + + return graphs.some(graph => graph.id !== this.id && graph.trimmed_name === this.trimmed_name) + } + + /** + * Check if this graph has domains + * @returns Whether this graph has domains + */ + + private hasDomains(): boolean { + return this.domain_ids.length > 0 + } + + /** + * Check if this graph has subjects + * @returns Whether this graph has subjects + */ + + private hasSubjects(): boolean { + return this.subject_ids.length > 0 + } + + /** + * Check if this graph has lectures + * @returns Whether this graph has lectures + */ + + private hasLectures(): boolean { + return this.lecture_ids.length > 0 + } + + /** + * Validate this graph + * @returns Validation result + */ + + async validate(): Promise { + const validation = new ValidationData() + + if (!this.hasName()) { + validation.add({ + severity: Severity.error, + short: 'Graph has no name', + tab: 0, + uuid: 'graph-name' + }) + } + + else if (await this.duplicateName()) { + validation.add({ + severity: Severity.error, + short: 'Graph name is not unique', + tab: 0, + uuid: 'graph-name' + }) + } + + if (!this.hasDomains()) { + validation.add({ + severity: Severity.warning, + short: 'Graph has no domains' + }) + } + + if (!this.hasSubjects()) { + validation.add({ + severity: Severity.warning, + short: 'Graph has no subjects' + }) + } + + if (!this.hasLectures()) { + validation.add({ + severity: Severity.warning, + short: 'Graph has no lectures' + }) + } + + const [domains, subjects, lectures] = await Promise.all([this.getDomains(), this.getSubjects(), this.getLectures()]) + for (const domain of domains) + validation.add(await domain.validate()) + for (const subject of subjects) + validation.add(await subject.validate()) + for (const lecture of lectures) { + validation.add(await lecture.validate()) + } + + return validation + } + + // --------------------> Assignments + + /** + * Assign a course to this graph + * @param course Course to assign to the graph + * @param mirror Whether to mirror the assignment + */ + + assignCourse(course: CourseController, mirror: boolean = true): void { + if (this._course_id === course.id) return + + // Unassign previous course + if (this._course_id && mirror) { + this.cache.find(CourseController, this._course_id) + ?.unassignGraph(this) + } + + // Assign new course + this._course_id = course.id + this._course = course + + if (mirror) { + course.assignGraph(this, false) + } + } + + /** + * Assign a domain to this graph + * @param domain Domain to assign to the graph + * @param mirror Whether to mirror the assignment + */ + + assignDomain(domain: DomainController, mirror: boolean = true): void { + if (this._domain_ids.includes(domain.id)) return + + // Assign domain + this._domain_ids.push(domain.id) + this._domains?.push(domain) + + if (mirror) { + domain.assignGraph(this, false) + } + } + + /** + * Create and assign a domain relation to this graph + * @param parent Parent domain + * @param child Child domain + * @param mirror Whether to mirror the assignment + */ + + createDomainRelation(parent: DomainController, child: DomainController, mirror: boolean = true): void { + if (this._domain_relations?.some(relation => relation.parent?.id === parent.id && relation.child?.id === child.id)) return + + // Create relation + const relation = new DomainRelationController(this, parent, child) + this._domain_relations?.push(relation) + + // Mirror to parent and child + if (mirror) { + parent.assignChild(child, false) + child.assignParent(parent, false) + } + } + + /** + * Assign a subject to this graph + * @param subject Subject to assign to the graph + * @param mirror Whether to mirror the assignment + */ + + assignSubject(subject: SubjectController, mirror: boolean = true): void { + if (this._subject_ids.includes(subject.id)) return + + // Assign subject + this._subject_ids.push(subject.id) + this._subjects?.push(subject) + + if (mirror) { + subject.assignGraph(this, false) + } + } + + /** + * Create and assign a subject relation to this graph + * @param parent Parent subject + * @param child Child subject + * @param mirror Whether to mirror the assignment + */ + + createSubjectRelation(parent: SubjectController, child: SubjectController, mirror: boolean = true): void { + if (this._subject_relations?.some(relation => relation.parent?.id === parent.id && relation.child?.id === child.id)) return + + // Create relation + const relation = new SubjectRelationController(this, parent, child) + this._subject_relations?.push(relation) + + // Mirror to parent and child + if (mirror) { + parent.assignChild(child, false) + child.assignParent(parent, false) + } + } + + /** + * Assign a lecture to this graph + * @param lecture Lecture to assign to the graph + * @param mirror Whether to mirror the assignment + */ + + assignLecture(lecture: LectureController, mirror: boolean = true): void { + if (this._lecture_ids.includes(lecture.id)) return + + // Assign lecture + this._lecture_ids.push(lecture.id) + this._lectures?.push(lecture) + + if (mirror) { + lecture.assignGraph(this, false) + } + } + + /** + * Assign a link to this graph + * @param link Link to assign to the graph + * @param mirror Whether to mirror the assignment + */ + + assignLink(link: LinkController, mirror: boolean = true): void { + if (this._links_ids.includes(link.id)) return + + // Assign link + this._links_ids.push(link.id) + this._links?.push(link) + + if (mirror) { + link.assignGraph(this, false) + } + } + + /** + * Unassign a domain from this graph + * @param domain Domain to unassign from the graph + */ + + unassignDomain(domain: DomainController): void { + if (!this._domain_ids.includes(domain.id)) return + + // Unassign domain + this._domain_ids = this._domain_ids.filter(id => id !== domain.id) + this._domains = this._domains?.filter(known => known !== domain) + } + + /** + * Unassign and delete a domain relation from this graph + * @param parent Parent domain of the relation + * @param child Child domain of the relation + * @param mirror Whether to mirror the unassignment + */ + + deleteDomainRelation(parent: DomainController, child: DomainController, mirror: boolean = true): void { + const relation = this._domain_relations?.find(relation => relation.parent?.id === parent.id && relation.child?.id === child.id) + if (!relation) return + + // Unassign relation + this._domain_relations = this._domain_relations?.filter(known => known !== relation) + + // Mirror to parent and child + if (mirror) { + parent.unassignChild(child, false) + child.unassignParent(parent, false) + } + } + + /** + * Unassign a subject from this graph + * @param subject Subject to unassign from the graph + */ + + unassignSubject(subject: SubjectController): void { + if (!this._subject_ids.includes(subject.id)) return + + // Unassign subject + this._subject_ids = this._subject_ids.filter(id => id !== subject.id) + this._subjects = this._subjects?.filter(known => known !== subject) + } + + /** + * Unassign and delete a subject relation from this graph + * @param parent Parent subject of the relation + * @param child Child subject of the relation + * @param mirror Whether to mirror the unassignment + */ + + deleteSubjectRelation(parent: SubjectController, child: SubjectController, mirror: boolean = true): void { + const relation = this._subject_relations?.find(relation => relation.parent?.id === parent.id && relation.child?.id === child.id) + if (!relation) return + + // Unassign relation + this._subject_relations = this._subject_relations?.filter(known => known !== relation) + + // Mirror to parent and child + if (mirror) { + parent.unassignChild(child, false) + child.unassignParent(parent, false) + } + } + + /** + * Unassign a lecture from this graph + * @param lecture Lecture to unassign from the graph + */ + + unassignLecture(lecture: LectureController): void { + if (!this._lecture_ids.includes(lecture.id)) return + + // Unassign lecture + this._lecture_ids = this._lecture_ids.filter(id => id !== lecture.id) + this._lectures = this._lectures?.filter(known => known !== lecture) + } + + /** + * Unassign a link from this graph + * @param link Link to unassign from the graph\ + * @param mirror Whether to mirror the unassignment + */ + + unassignLink(link: LinkController, mirror: boolean = true): void { + if (!this._links_ids.includes(link.id)) return + + // Unassign link + this._links_ids = this._links_ids.filter(id => id !== link.id) + this._links = this._links?.filter(known => known !== link) + + if (mirror) { + link.unassignGraph(false) + } + } + + // --------------------> Utility + + /** + * Sort this graph + * @param option Sort option + * @throws `GraphError` if the sort option is invalid + */ + + async sort(option: number): Promise { + let descending: boolean + if (option & SortOption.descending) { + descending = true + } else if (option & SortOption.ascending) { + descending = false + } else { + throw new Error('GraphError: Invalid sort option') + } + + if (option & SortOption.relations) { + if (option & SortOption.domains) { + if (option & SortOption.index) { + // Sort domain relations by index + } else if (option & SortOption.parents) { + // Sort domain relations by parents + } else if (option & SortOption.children) { + // Sort domain relations by children + } else { + throw new Error('GraphError: Invalid sort option') + } + } else if (option & SortOption.subjects) { + if (option & SortOption.index) { + // Sort subject relations by index + } else if (option & SortOption.parents) { + // Sort subject relations by parents + } else if (option & SortOption.children) { + // Sort subject relations by children + } else { + throw new Error('GraphError: Invalid sort option') + } + } else { + throw new Error('GraphError: Invalid sort option') + } + } else { + if (option & SortOption.subjects) { + const subjects = await this.getSubjects() + let comparable: { value: string, subject: SubjectController }[] + + // Sort subjects by index + if (option & SortOption.index) { + comparable = await Promise.all( + subjects.map(async subject => ({ + value: String(await subject.getIndex()), + subject + })) + ) + } + + // Sort subjects by name + else if (option & SortOption.name) { + comparable = subjects.map(subject => ({ + value: subject.trimmed_name, + subject + })) + } + + // Sort subjects by domain + else if (option & SortOption.domains) { + comparable = await Promise.all( + subjects.map(async subject => ({ + value: await subject.getDomain().then(domain => domain?.trimmed_name || ''), + subject + })) + ) + } + + else { + throw new Error('GraphError: Invalid sort option') + } + + // Sort the subjects + comparable.sort((a, b) => a.value.localeCompare(b.value)) + if (descending) comparable.reverse() + this._subjects = comparable.map(pair => pair.subject) + + } else if (option & SortOption.domains) { + const domains = await this.getDomains() + let comparable: { value: string, domain: DomainController }[] + + // Sort domains by index + if (option & SortOption.index) { + comparable = await Promise.all( + domains.map(async domain => ({ + value: String(await domain.getIndex()), + domain + })) + ) + } + + // Sort domains by name + else if (option & SortOption.name) { + comparable = domains.map(domain => ({ + value: domain.trimmed_name, + domain + })) + } + + // Sort domains by style + else if (option & SortOption.style) { + comparable = await Promise.all( + domains.map(async domain => ({ + value: await domain.getStyle() || '', + domain + })) + ) + } + + else { + throw new Error('GraphError: Invalid sort option') + } + + // Sort the domains + comparable.sort((a, b) => a.value.localeCompare(b.value)) + if (descending) comparable.reverse() + this._domains = comparable.map(pair => pair.domain) + + } else { + throw new Error('GraphError: Invalid sort option') + } + } + } +} \ No newline at end of file diff --git a/src/lib/scripts/controllers/LectureController.ts b/src/lib/scripts/controllers/LectureController.ts new file mode 100644 index 0000000..1b30fa0 --- /dev/null +++ b/src/lib/scripts/controllers/LectureController.ts @@ -0,0 +1,458 @@ + +// External dependencies +import * as uuid from 'uuid' +import { browser } from '$app/environment' + +// Internal dependencies +import { ValidationData, Severity } from '$scripts/validation' + +import { + ControllerCache, + GraphController, + SubjectController +} from '$scripts/controllers' + +import type { + SerializedLecture, + SerializedSubject, + SerializedGraph +} from '$scripts/types' +import type { Graph } from '@prisma/client' + +// Exports +export { LectureController } + + +// --------------------> Classes + + +class LectureController { + private _graph?: GraphController + private _subjects?: SubjectController[] + + uuid: string + + constructor( + public cache: ControllerCache, + public id: number, + public name: string, + private _graph_id: number, + private _subject_ids: number[] + ) { + this.uuid = uuid.v4() + this.cache.add(this) + } + + // --------------------> Getters & Setters + + get trimmed_name(): string { + return this.name.trim() + } + + get graph_id(): number { + return this._graph_id + } + + set graph_id(id: number) { + + // Unassign previous graph + this.cache.find(GraphController, this._graph_id) + ?.unassignLecture(this) + + // Assign new graph + this._graph_id = id + this._graph = undefined + + this.cache.find(GraphController, this._graph_id) + ?.assignLecture(this, false) + } + + get subject_ids(): number[] { + return Array.from(this._subject_ids) + } + + // --------------------> API Getters + + /** + * Get the graph associated to this lecture + * @returns The associated graph + * @throws `APIError` if the API call fails + */ + + async getGraph(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if the graph is already loaded + if (this._graph) { + return this._graph + } + + // Call API to fetch the course data + const response = await fetch(`/api/lecture/${this.id}/graph`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/lecture/${this.id}/graph GET): ${error}`) + }) + + // Revive the course + const data = await response.json() as SerializedGraph + this._graph = GraphController.revive(this.cache, data) + + return this._graph + } + + /** + * Get the subjects associated to this lecture + * @returns The associated subjects + * @throws `APIError` if the API + */ + + async getSubjects(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if the subjects are already loaded + if (this._subjects) { + return Array.from(this._subjects) + } + + // Call API to fetch the subjects data + const response = await fetch(`/api/lecture/${this.id}/subjects`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/lecture/${this.id}/subjects GET): ${error}`) + }) + + // Revive the subjects + const data = await response.json() as SerializedSubject[] + this._subjects = data.map(item => SubjectController.revive(this.cache, item)) + + return Array.from(this._subjects) + } + + // --------------------> API Actions + + /** + * Create a new lecture + * @param cache Cache to create the lecture with + * @param graph Graph to assign the lecture to + * @returns The newly created LectureController + * @throws `APIError` if the API call fails + */ + + static async create(cache: ControllerCache, graph: GraphController): Promise { + + // Call API to create a new lecture + const response = await fetch(`/api/lecture`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ graph: graph.id }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/lecture POST): ${error}`) + }) + + // Revive the lecture + const data = await response.json() + const lecture = LectureController.revive(cache, data) + + // Assign the lecture to the graph + graph.assignLecture(lecture) + + return lecture + } + + /** + * Revive a lecture from serialized data, or retrieves an existing lecture from the cache + * @param cache Cache to revive the lecture with + * @param data Serialized data to revive + * @returns The revived LectureController + * @throws `LectureError` if the server data is out of sync with the cache + */ + + static revive(cache: ControllerCache, data: SerializedLecture): LectureController { + const existing = cache.find(LectureController, data.id) + if (existing) { + if (!existing.represents(data)) + throw new Error(`LectureError: Attempted to revive Lecture with ID ${data.id}, but server data is out of sync with cache`) + return existing + } + + return new LectureController( + cache, + data.id, + data.name, + data.graph, + data.subjects + ) + } + + /** + * Check if this lecture represents the serialized data + * @param data Serialized data to compare against + * @returns Whether the lecture represents the serialized data + */ + + represents(data: SerializedLecture): boolean { + + // Check the easy stuff + if ( + this.id !== data.id || + this.trimmed_name !== data.name || + this._graph_id !== data.graph + ) { + return false + } + + // Check the subjects + if ( + this._subject_ids.length !== data.subjects.length || + this._subject_ids.some(id => !data.subjects.includes(id)) || + data.subjects.some(id => !this._subject_ids.includes(id)) + ) { + return false + } + + return true + } + + /** + * Serialize the lecture + * @returns Serialized lecture + */ + + reduce(): SerializedLecture { + return { + id: this.id, + name: this.trimmed_name, + graph: this._graph_id, + subjects: this._subject_ids + } + } + + /** + * Save this lecture + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Call API to save the lecture + await fetch(`/api/lecture`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/lecture PUT): ${error}`) + }) + } + + /** + * Delete this lecture + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Call API to delete the lecture + await fetch(`/api/lecture/${this.id}`, { + method: 'DELETE', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ id: this.id }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/lecture/${this.id} DELETE): ${error}`) + }) + + // Unassign from graph + this.cache.find(GraphController, this._graph_id) + ?.unassignLecture(this) + + // Unassign from subjects + for (const id of this._subject_ids) { + this.cache.find(SubjectController, id) + ?.unassignLecture(this, false) + } + + // Remove from environment + this.cache.remove(this) + } + + /** + * Copy this lecture + * @param target_graph Graph to copy the lecture to + * @returns The copied lecture + */ + + async copy(target_graph: GraphController): Promise { + const lecture_copy = await LectureController.create(this.cache, target_graph) + + lecture_copy.name = this.name + + await lecture_copy.save() + return lecture_copy + } + + // --------------------> Validation + + /** + * Check if this lecture has a name + * @returns Whether the lecture has a name + */ + + private hasName(): boolean { + return this.trimmed_name !== '' + } + + /** + * Find the first occurrence of this lectures's name in the graph, ordered by index + * @returns Index of the original name in the graph, or -1 if the name is original/nonexistant + * @throws `LectureError` if the lecture is not found in the graph + */ + + private async findOriginalName(): Promise { + if (this.trimmed_name === '') { + return -1 + } + + const graph = await this.getGraph() + const lectures = await graph.getLectures() + + for (let index = 0; index < graph.lecture_ids.length; index++) { + if (graph.lecture_ids[index] === this.id) { + return -1 + } + + const lecture = lectures.find(lecture => lecture.id === graph.lecture_ids[index]) + if (lecture === undefined) throw new Error('LectureError: Lecture not found in graph') + if (lecture.name === this.trimmed_name) return index + } + + throw new Error('LectureError: Lecture not found in graph') + } + + /** + * Check if this lecture has subjects + * @returns Whether the lecture has subjects + */ + + private hasSubjects(): boolean { + return this._subject_ids.length > 0 + } + + /** + * Validate this lecture + * @returns Validation result + */ + + async validate(): Promise { + const validation = new ValidationData() + + if (!this.hasName()) { + validation.add({ + severity: Severity.error, + short: 'Lecture has no name', + tab: 3, + uuid: this.uuid + }) + } + + else { + const original = await this.findOriginalName() + if (original !== -1) { + validation.add({ + severity: Severity.warning, + short: 'Lecture name is already in use', + long: `Name first used by Lecture nr. ${original + 1}`, + tab: 3, + uuid: this.uuid + }) + } + } + + if (!this.hasSubjects()) { + validation.add({ + severity: Severity.warning, + short: 'Lecture has no subjects', + tab: 3, + uuid: this.uuid + }) + } + + return validation + } + + // --------------------> Assignments + + /** + * Assign the lecture to a graph + * @param graph Graph to assign the lecture to + * @param mirror Whether to mirror the assignment + */ + + assignGraph(graph: GraphController, mirror: boolean = true): void { + if (this._graph_id === graph.id) return + + // Unassign previous graph + if (mirror) { + this.cache.find(GraphController, this._graph_id) + ?.unassignLecture(this) + } + + // Assign new graph + this._graph_id = graph.id + this._graph = graph + + if (mirror) { + graph.assignLecture(this, false) + } + } + + /** + * Assign a subject to the lecture + * @param subject Subject to assign to the lecture + * @param mirror Whether to mirror the assignment + */ + + assignSubject(subject: SubjectController, mirror: boolean = true): void { + if (this._subject_ids.includes(subject.id)) return + + // Assign subject + this._subject_ids.push(subject.id) + this._subjects?.push(subject) + + if (mirror) { + subject.assignLecture(this, false) + } + } + + /** + * Unassign a subject from the lecture + * @param subject Subject to unassign from the lecture + * @param mirror Whether to mirror the unassignment + */ + + unassignSubject(subject: SubjectController, mirror: boolean = true): void { + if (!this._subject_ids.includes(subject.id)) return + + // Unassign subject + this._subject_ids = this._subject_ids.filter(id => id !== subject.id) + this._subjects = this._subjects?.filter(subject => subject.id !== subject.id) + + if (mirror) { + subject.unassignLecture(this, false) + } + } +} \ No newline at end of file diff --git a/src/lib/scripts/controllers/LinkController.ts b/src/lib/scripts/controllers/LinkController.ts new file mode 100644 index 0000000..e164193 --- /dev/null +++ b/src/lib/scripts/controllers/LinkController.ts @@ -0,0 +1,438 @@ + +// External dependencies +import { browser } from "$app/environment" + +// Internal dependencies +import { ValidationData, Severity } from "$scripts/validation" + +import { + ControllerCache, + CourseController, + GraphController +} from "$scripts/controllers" + +import type { + SerializedLink, + SerializedCourse, + SerializedGraph +} from "$scripts/types" + +// Exports +export { LinkController } + +const BASE_URL = 'http://localhost:5432' + + +// --------------------> Controller + + +class LinkController { + private _course?: CourseController + private _graph?: GraphController | null + + private constructor( + public cache: ControllerCache, + public id: number, + public name: string, + private _course_id: number, + private _graph_id: number | null + ) { + this.cache.add(this) + } + + // --------------------> Getters & Setters + + get trimmed_name(): string { + return this.name.trim() + } + + get course_id(): number { + return this._course_id + } + + set course_id(id: number) { + + // Unassign previous course + this.cache.find(CourseController, this._course_id) + ?.unassignLink(this) + + // Assign new course + this._course = undefined + this._course_id = id + + this.cache.find(CourseController, this._course_id) + ?.assignLink(this, false) + } + + get graph_id(): number | null { + return this._graph_id + } + + set graph_id(id: number | null) { + + // Unassign previous graph + if (this._graph_id) { + this.cache.find(GraphController, this._graph_id) + ?.unassignLink(this, false) + } + + // Assign new graph + this._graph = undefined + this._graph_id = id + + if (this._graph_id) { + this.cache.find(GraphController, this._graph_id) + ?.assignLink(this) + } + } + + // --------------------> API Getters + + /** + * Get the course associated to this link + * @returns The associated course + * @throws `APIError` if the API call fails + */ + + async getCourse(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if the course is already loaded + if (this._course) { + return this._course + } + + // Call API to fetch the course data + const response = await fetch(`/api/link/${this.id}/course`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/course/${this.id}/course GET): ${error}`) + }) + + // Revive the course + const data = await response.json() as SerializedCourse + this._course = CourseController.revive(this.cache, data) + + return this._course + } + + /** + * Get the graph associated to this link + * @returns The associated graph + * @throws `APIError` if the API call fails + */ + + async getGraph(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if the graph is already loaded + if (this._graph) { + return this._graph + } + + // Call API to fetch the graph data + const response = await fetch(`/api/link/${this.id}/graph`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/link/${this.id}/graph GET): ${error}`) + }) + + // Revive the graph + const data = await response.json() as SerializedGraph + if (data === null) return null + this._graph = GraphController.revive(this.cache, data) + + return this._graph + } + + /** + * Get the URL of this link + * @returns The URL of the link + */ + + async getURL(): Promise { + if (!this.validate().okay()) { + return Promise.reject() + } + + // Build the URL + const course = await this.getCourse() + return `${BASE_URL}/graph/${course.code}/${this.trimmed_name}` + } + + // --------------------> API Actions + + /** + * Create a new link + * @param cache Controller cache to create link with + * @param name Link name + * @param course_id Course id to assign the link to + * @param graph_id Graph id to assign the link to + * @returns The newly created LinkController + * @throws `APIError` If the API request fails + */ + + static async create(cache: ControllerCache, course_id: number, graph_id: number | null, name: string): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to create a new link + const response = await fetch('/api/link', { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ name, course: course_id, graph: graph_id }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/link POST): ${error}`) + }) + + // Revive the course + const data = await response.json() as SerializedLink + const link = LinkController.revive(cache, data) + + // Assign to course and graph + cache.find(CourseController, course_id) + ?.assignLink(link, false) + + if (graph_id) { + cache.find(GraphController, graph_id) + ?.assignLink(link, false) + } + + return link + } + + /** + * Revive a link from serialized data, or retrieves an existing link from the cache + * @param cache Controller cache to revive link with + * @param data Serialized link data + * @returns The revived LinkController + * @throws `LinkError` if the server data is out of sync with the cache + */ + + static revive(cache: ControllerCache, data: SerializedLink): LinkController { + const link = cache.find(LinkController, data.id) + if (link) { + if (!link.represents(data)) + throw new Error(`LinkError: Attempted to revive Link with ID ${data.id}, but server data is out of sync with cache`) + return link + } + + return new LinkController( + cache, + data.id, + data.name, + data.course, + data.graph + ) + } + + /** + * Check if this link is equal to a serialized link + * @param data Serialized link to compare against + * @returns Whether the link is equal to the serialized link + */ + + represents(data: SerializedLink): boolean { + return ( + this.id === data.id && + this.trimmed_name === data.name && + this._course_id === data.course && + this._graph_id === data.graph + ) + } + + /** + * Serialize this link + * @returns Serialized link data + */ + + reduce(): SerializedLink { + return { + id: this.id, + name: this.trimmed_name, + course: this._course_id, + graph: this._graph_id + } + } + + /** + * Save this link + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to save the link + await fetch(`/api/link`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/link PUT): ${error}`) + }) + } + + /** + * Delete this link + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Unassign everywhere (mirroring is not necessary, as this object will be deleted) + this.cache.find(CourseController, this._course_id) + ?.unassignLink(this) + + if (this._graph_id) { + this.cache.find(GraphController, this._graph_id) + ?.unassignLink(this, false) + } + + // Call API to delete the link + await fetch(`/api/link/${this.id}`, { method: 'DELETE' }) + .catch(error => { + throw new Error(`APIError (/api/link/${this.id} DELETE): ${error}`) + }) + + // Remove from cache + this.cache.remove(this) + } + + // --------------------> Validation + + /** + * Check if the link has a name + * @returns Whether the link has a name + */ + + private hasName(): boolean { + return this.trimmed_name !== '' + } + + /** + * Check if the link has a graph + * @returns Whether the link has a graph + */ + + private hasGraph(): boolean { + return this._graph_id !== null + } + + /** + * Validate the link + * @returns `ValidationData` Validation data + */ + + validate(): ValidationData { + const validation = new ValidationData() + + if (!this.hasName()) { + validation.add({ + severity: Severity.error, + short: 'Link has no name' + }) + } + + if (!this.hasGraph()) { + validation.add({ + severity: Severity.error, + short: 'Link has no associated graph' + }) + } + + return validation + } + + // --------------------> Assignments + + /** + * Assign a course to this link + * @param course Target course + * @param Whether to mirror the assignment + */ + + assignCourse(course: CourseController, mirror: boolean = true): void { + if (this._course_id === course.id) return + + // Unassign previous course + if (this._course_id && mirror) { + this.cache.find(CourseController, this._course_id) + ?.unassignLink(this) + } + + // Assign new course + this._course_id = course.id + this._course = course + + if (mirror) { + course.assignLink(this, false) + } + } + + /** + * Assign a graph to this link + * @param graph Target graph + * @param Whether to mirror the assignment + */ + + assignGraph(graph: GraphController, mirror: boolean = true): void { + if (this._graph_id === graph?.id) return + + // Unassign previous graph + if (this._graph_id && mirror) { + this.cache.find(GraphController, this._graph_id) + ?.unassignLink(this, false) + } + + // Assign new graph + this._graph_id = graph?.id + this._graph = graph + + if (mirror) { + graph.assignLink(this, false) + } + } + + /** + * Unassign a graph from this link + * @param Whether to mirror the unassignment + */ + + unassignGraph(mirror: boolean = true): void { + if (!this._graph_id) return + + // Unassign graph + if (mirror) { + this.cache.find(GraphController, this._graph_id) + ?.unassignLink(this, false) + } + + this._graph_id = null + this._graph = null + } +} \ No newline at end of file diff --git a/src/lib/scripts/controllers/ProgramController.ts b/src/lib/scripts/controllers/ProgramController.ts new file mode 100644 index 0000000..57441dd --- /dev/null +++ b/src/lib/scripts/controllers/ProgramController.ts @@ -0,0 +1,535 @@ + +// External dependencies +import { browser } from '$app/environment' + +// Internal dependencies +import { ValidationData, Severity } from '$scripts/validation' + +import { + ControllerCache, + CourseController, + UserController +} from '$scripts/controllers' + +import type { + SerializedProgram, + SerializedCourse, + SerializedUser +} from '$scripts/types' + +// Exports +export { ProgramController } + + +// --------------------> Controller + + +class ProgramController { + private _courses?: CourseController[] + private _admins?: UserController[] + private _editors?: UserController[] + + private constructor( + public cache: ControllerCache, + public id: number, + public name: string, + private _course_ids: number[], + private _editor_ids: number[], + private _admin_ids: number[] + ) { + this.cache.add(this) + } + + // --------------------> Getters & Setters + + get trimmed_name(): string { + return this.name.trim() + } + + get course_ids(): number[] { + return Array.from(this._course_ids) + } + + get admin_ids(): number[] { + return Array.from(this._admin_ids) + } + + get editor_ids(): number[] { + return Array.from(this._editor_ids) + } + + // --------------------> API Getters + + static async getAll(cache: ControllerCache): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to get all programs + const response = await fetch(`/api/program`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/program GET): ${error}`) + }) + + // Revive the programs + const data = await response.json() as SerializedProgram[] + return data.map(program => ProgramController.revive(cache, program)) + } + + /** + * Get the courses of this program, from the cache or the API + * @returns Courses of the program + * @throws `APIError` if the API call fails + */ + + async getCourses(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if courses are already loaded + if (this._courses) { + return Array.from(this._courses) + } + + // Call API to get the course data + const response = await fetch(`/api/program/${this.id}/courses`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/program/${this.id}/courses GET): ${error}`) + }) + + // Revive the courses + const data = await response.json() as SerializedCourse[] + this._courses = data.map(course => CourseController.revive(this.cache, course)) + + return Array.from(this._courses) + } + + /** + * Get the admins of this program, from the cache or the API + * @returns Admins of the program + * @throws `APIError` if the API call fails + */ + + async getAdmins(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if admins are already loaded + if (this._admins) { + return Array.from(this._admins) + } + + // Call API to get the admin data + const response = await fetch(`/api/program/${this.id}/admins`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/program/${this.id}/admins GET): ${error}`) + }) + + // Revive the admins + const data = await response.json() as SerializedUser[] + this._admins = data.map(user => UserController.revive(this.cache, user)) + + return Array.from(this._admins) + } + + /** + * Get the editors of this program, from the cache or the API + * @returns Editors of the program + * @throws `APIError` if the API call fails + */ + + async getEditors(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Check if editors are already loaded + if (this._editors) { + return Array.from(this._editors) + } + + // Call API to get the editor data + const response = await fetch(`/api/program/${this.id}/editors`, { method: 'GET' }) + .catch(error => { + throw new Error(`APIError (/api/program/${this.id}/editors GET): ${error}`) + }) + + // Revive the editors + const data = await response.json() as SerializedUser[] + this._editors = data.map(user => UserController.revive(this.cache, user)) + + return Array.from(this._editors) + } + + // --------------------> API actions + + /** + * Create a new program + * @param cache Cache to create the program with + * @param name Program name + * @returns The newly created ProgramController + * @throws `APIError` If the API call fails + */ + + static async create(cache: ControllerCache, name: string): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to create a new program + const response = await fetch(`/api/program`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ name }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/program POST): ${error}`) + }) + + // Revive the course + const data = await response.json() as SerializedProgram + return ProgramController.revive(cache, data) + } + + /** + * Revive a program from serialized data or the cache + * @param cache Cache to revive the program with + * @param data Serialized data to revive + * @returns The revived ProgramController + * @throws `ProgramError` if the server data is out of sync with the cache + */ + + static revive(cache: ControllerCache, data: SerializedProgram): ProgramController { + const program = cache.find(ProgramController, data.id) + if (program) { + if (!program.represents(data)) + throw new Error(`ProgramError: Attempted to revive Program with ID ${data.id}, but server data is out of sync with cache`) + return program + } + + return new ProgramController( + cache, + data.id, + data.name, + data.courses, + data.editors, + data.admins + ) + } + + /** + * Check if this program is equal to a serialized program + * @param data Serialized program to compare against + * @returns Whether the program is equal to the serialized program + */ + + represents(data: SerializedProgram): boolean { + + // Check the easy stuff + if ( + this.id !== data.id || + this.trimmed_name !== data.name + ) { + return false + } + + // Check courses + if ( + this._course_ids.length !== data.courses.length || + this._course_ids.some(id => !data.courses.includes(id)) || + data.courses.some(id => !this._course_ids.includes(id)) + ) { + return false + } + + // Check admins + if ( + this._admin_ids.length !== data.admins.length || + this._admin_ids.some(id => !data.admins.includes(id)) || + data.admins.some(id => !this._admin_ids.includes(id)) + ) { + return false + } + + // Check editors + if ( + this._editor_ids.length !== data.editors.length || + this._editor_ids.some(id => !data.editors.includes(id)) || + data.editors.some(id => !this._editor_ids.includes(id)) + ) { + return false + } + + return true + } + + /** + * Serialize this program + * @returns `SerializedProgram` Serialized program + */ + + reduce(): SerializedProgram { + return { + id: this.id, + name: this.trimmed_name, + courses: this._course_ids, + admins: this._admin_ids, + editors: this._editor_ids + } + } + + /** + * Save this program + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.reject() + } + + // Call API to save the program + await fetch(`/api/program`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/program PUT): ${error}`) + }) + } + + /** + * Delete this program + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Guard against SSR + if (!browser) { + return Promise.resolve() + } + + // Unassign everywhere (mirroring is not necessary, as this object will be deleted) + for (const id of this._course_ids) { + this.cache.find(CourseController, id) + ?.unassignProgram(this, false) + } + + for (const id of this._admin_ids) { + this.cache.find(UserController, id) + ?.resignAsProgramAdmin(this, false) + } + + for (const id of this._editor_ids) { + this.cache.find(UserController, id) + ?.resignAsProgramEditor(this, false) + } + + // Call API to delete the program + await fetch(`/api/program/${this.id}`, { method: 'DELETE' }) + .catch(error => { + throw new Error(`APIError (/api/program/${this.id} DELETE): ${error}`) + }) + + // Remove from cache + this.cache.remove(this) + } + + // --------------------> Validation + + /** + * Check if this program has a name + * @returns Whether the program has a name + */ + + private hasName(): boolean { + return this.trimmed_name !== '' + } + + /** + * Check if this program has admins + * @returns Whether the program has admins + */ + + private hasAdmins(): boolean { + return this._admin_ids.length > 0 + } + + /** + * Validate this program + * @returns Validation result + */ + + validate(): ValidationData { + const validation = new ValidationData() + + if (!this.hasName()) { + validation.add({ + severity: Severity.error, + short: 'Program has no name' + }) + + } + + if (!this.hasAdmins()) { + validation.add({ + severity: Severity.warning, + short: 'Program has no admins' + }) + } + + return validation + } + + // --------------------> Assignments + + /** + * Assign a course to this program + * @param course Course to assign to the program + * @param mirror Whether to mirror the assignment + */ + + assignCourse(course: CourseController, mirror: boolean = true): void { + if (this._course_ids.includes(course.id)) return + + // Assign course + this._course_ids.push(course.id) + this._courses?.push(course) + + if (mirror) { + course.assignProgram(this, false) + } + } + + /** + * Assign a user as an admin of this program. Unassigns the user as an editor if they are one + * @param user User to assign as an admin + * @param mirror Whether to mirror the assignment + */ + + assignAdmin(user: UserController, mirror: boolean = true): void { + if (this._admin_ids.includes(user.id)) return + + // Unassign as editor + if (this._editor_ids.includes(user.id)) { + this.unassignEditor(user, mirror) + } + + // Assign as admin + this._admin_ids.push(user.id) + this._admins?.push(user) + + if (mirror) { + user.becomeProgramAdmin(this, false) + } + } + + /** + * Assign a user as an editor of this program. Unassigns the user as an admin if they are one + * @param user User to assign as an editor + * @param mirror Whether to mirror the assignment + */ + + assignEditor(user: UserController, mirror: boolean = true): void { + if (this._editor_ids.includes(user.id)) return + + // Unassign as admin + if (this._admin_ids.includes(user.id)) { + this.unassignAdmin(user, mirror) + } + + // Assign as editor + this._editor_ids.push(user.id) + this._editors?.push(user) + + if (mirror) { + user.becomeProgramEditor(this, false) + } + } + + /** + * Unassign a course from this program + * @param course Course to unassign from the program + * @param mirror Whether to mirror the unassignment + */ + + unassignCourse(course: CourseController, mirror: boolean = true): void { + if (!this._course_ids.includes(course.id)) return + + // Unassign course + this._course_ids = this._course_ids.filter(id => id !== course.id) + this._courses = this._courses?.filter(known => known.id !== course.id) + + if (mirror) { + course.unassignProgram(this, false) + } + } + + /** + * Unassign an admin from this program + * @param user User to unassign as an admin + * @param mirror Whether to mirror the unassignment + */ + + unassignAdmin(user: UserController, mirror: boolean = true): void { + if (!this._admin_ids.includes(user.id)) return + + // Unassign admin + this._admin_ids = this._admin_ids.filter(id => id !== user.id) + this._admins = this._admins?.filter(known => known.id !== user.id) + + if (mirror) { + user.resignAsProgramAdmin(this, false) + } + } + + /** + * Unassign an editor from this program + * @param user User to unassign as an editor + * @param mirror Whether to mirror the unassignment + */ + + unassignEditor(user: UserController, mirror: boolean = true): void { + if (!this._editor_ids.includes(user.id)) return + + // Unassign editor + this._editor_ids = this._editor_ids.filter(id => id !== user.id) + this._editors = this._editors?.filter(known => known.id !== user.id) + + if (mirror) { + user.resignAsProgramEditor(this, false) + } + } + + // --------------------> Utility + + /** + * Checks if this program matches a query + * @param query Query to match against + * @returns Whether the program matches the query + */ + + matchesQuery(query: string): boolean { + return this.trimmed_name.toLowerCase().includes(query.toLowerCase()) + } +} diff --git a/src/lib/scripts/controllers/RelationControllers.ts b/src/lib/scripts/controllers/RelationControllers.ts new file mode 100644 index 0000000..9f5eb81 --- /dev/null +++ b/src/lib/scripts/controllers/RelationControllers.ts @@ -0,0 +1,475 @@ + +// External dependencies +import * as uuid from 'uuid' + +// Internal dependencies +import { ValidationData, Severity } from '$scripts/validation' + +import { + GraphController, + DomainController, + SubjectController, + FieldController +} from '$scripts/controllers' + +// Exports +export { + RelationController, + DomainRelationController, + SubjectRelationController +} + + +// --------------------> Controllers + + +abstract class RelationController { + uuid: string + + constructor( + public graph: GraphController, + protected _parent?: FieldController, + protected _child?: FieldController + ) { + this.uuid = uuid.v4() + } + + // --------------------> Getters & Setters + + get parent(): FieldController | undefined { + return this._parent + } + + set parent(parent: FieldController | undefined) { + if (this.parent === parent) return + + // Update parent and child references + if (this.child) { + if (this.parent) + this.child.unassignParent(this.parent) + if (parent) { + this.child.assignParent(parent) + } + } + + this._parent = parent + } + + get child(): FieldController | undefined { + return this._child + } + + set child(child: FieldController | undefined) { + if (this.child === child) return + + // Update parent and child references + if (this.parent) { + if (this.child) + this.parent.unassignChild(this.child) + if (child) { + this.parent.assignChild(child) + } + } + + this._child = child + } + + // --------------------> API Getters + + /** + * Get the color of the parent field + * @returns A css color + */ + + async getParentColor(): Promise { + return await this.parent?.getColor() || 'transparent' + } + + /** + * Get the color of the child field + * @returns A css color + */ + + async getChildColor(): Promise { + return await this.child?.getColor() || 'transparent' + } + + // --------------------> Validation + + /** + * Check if a field has a name + * @param field The field to check + * @returns Whether the field has a name + */ + + protected hasName(field: FieldController): boolean { + return field.trimmed_name !== '' + } + + /** + * Check if the given values are all defined + * @param values The values to check + * @returns Whether all values are defined + */ + + protected isDefined(...values: (any | undefined)[]): boolean { + return values.every(value => value !== undefined) + } + + /** + * Uses a depth first search to check if a relation is cyclic + * @param parent The parent field + * @param child The child field + * @returns Whether the relation is cyclic + */ + + protected async isCyclic(parent?: FieldController, child?: FieldController): Promise { + let stack: FieldController[] = [child!] + while (stack.length > 0) { + + // Pop the current node + const current = stack.pop()! + if (current === parent) { + return true + } + + // Add children to the stack + const children = await current.getChildren() + stack.push(...children) + } + + return false + } + + /** + * Check if a relation is self referential + * @param parent The parent field + * @param child The child field + * @returns Whether the relation is self referential + */ + + protected isSelfReferential(parent?: FieldController, child?: FieldController): boolean { + return parent === child + } + + // --------------------> Abstract + + abstract getParentOptions(): Promise<{ value: FieldController, label: string, validation: ValidationData }[]> + abstract getChildOptions(): Promise<{ value: FieldController, label: string, validation: ValidationData }[]> + + abstract validate(): Promise +} + +class DomainRelationController extends RelationController { + + // --------------------> API Getters + + /** + * Get the parent options for this domain relation + * @returns The parent options + */ + + async getParentOptions(): Promise<{ value: DomainController, label: string, validation: ValidationData }[]> { + const options: { value: DomainController, label: string, validation: ValidationData }[] = [] + const domains = await this.graph.getDomains() + + for (const domain of domains) { + + // Check if the domain has a name + if (!this.hasName(domain)) continue + + // Add the domain to options + options.push({ + value: domain, + label: domain.trimmed_name, + validation: await this.validateOption(domain, this.child as DomainController) + }) + } + + return options + } + + /** + * Get the child options for this domain relation + * @returns The child options + */ + + async getChildOptions(): Promise<{ value: DomainController, label: string, validation: ValidationData }[]> { + const options: { value: DomainController, label: string, validation: ValidationData }[] = [] + const domains = await this.graph.getDomains() + + for (const domain of domains) { + + // Check if the domain has a name + if (!this.hasName(domain)) continue + + // Add the domain to options + options.push({ + value: domain, + label: domain.trimmed_name, + validation: await this.validateOption(this.parent as DomainController, domain) + }) + } + + return options + } + + // --------------------> Validation + + /** + * Check if the relation already exists + * @param parent The parent domain + * @param child The child domain + * @returns Whether the relation already exists + */ + + private async isDuplicate(parent?: DomainController, child?: DomainController): Promise { + const domain_relations = await this.graph.getDomainRelations() + return domain_relations.find(relation => + relation.parent === parent && + relation.child === child + ) !== undefined + } + + /** + * Check if there exists a subject relation that is consistent with this domain relation + * @param parent The parent domain + * @param child The child domain + * @returns Whether the relation is inconsistent + */ + + private async isInconsistent(parent?: DomainController, child?: DomainController): Promise { + const subject_relations = await this.graph.getSubjectRelations() + return subject_relations.find(relation => + relation.parent === parent && + relation.child === child + ) !== undefined + } + + /** + * Validate an option for this domain relation + * @param parent The parent domain + * @param child The child domain + * @returns The validation data + */ + + private async validateOption(parent?: DomainController, child?: DomainController): Promise { + const validation = new ValidationData() + + // Check if the relation is defined + if (!this.isDefined(parent, child)) { + return validation + } + + // Check if the relation is self-referential + if (this.isSelfReferential(parent, child)) { + validation.add({ severity: Severity.error, short: 'Self-referential' }) + } + + // Check if the relation is a duplicate + else if (await this.isDuplicate(parent, child)) { + validation.add({ severity: Severity.error, short: 'Duplicate relation' }) + } + + // Check if the relation is cyclic + else if (await this.isCyclic(parent, child)) { + validation.add({ severity: Severity.error, short: 'Cyclic relation' }) + } + + // Check if the relation is consistent + else if (await this.isInconsistent(parent, child)) { + validation.add({ severity: Severity.warning, short: 'Inconsistent' }) + } + + return validation + } + + /** + * Validate the domain relation + * @returns Validation result + */ + + async validate(): Promise { + const validation = new ValidationData() + + // Check if the parent and child are defined + if (!this.isDefined(this.parent, this.child)) { + validation.add({ + severity: Severity.error, + short: 'Domain relation is not fully defined', + long: 'Both the parent and child domains must be selected', + tab: 1, + uuid: this.uuid + }) + } + + // Check if the relation is cyclic + else if (await this.isCyclic(this.parent, this.child)) { + validation.add({ + severity: Severity.error, + short: 'Domain relation is cyclic', + long: 'The parent and child domains are cyclically related', + tab: 1, + uuid: this.uuid + }) + } + + return validation + } +} + +class SubjectRelationController extends RelationController { + + // --------------------> API Getters + + /** + * Get the parent options for this subject relation + * @returns The parent options + */ + + async getParentOptions(): Promise<{ value: SubjectController, label: string, validation: ValidationData }[]> { + const options: { value: SubjectController, label: string, validation: ValidationData }[] = [] + const subjects = await this.graph.getSubjects() + for (const subject of subjects) { + + // Check if the subject has a name + if (!this.hasName(subject)) continue + + // Add the subject to options + options.push({ + value: subject, + label: subject.trimmed_name, + validation: await this.validateOption(subject, this.child as SubjectController) + }) + } + + return options + } + + /** + * Get the child options for this subject relation + * @returns The child options + */ + + async getChildOptions(): Promise<{ value: SubjectController, label: string, validation: ValidationData }[]> { + const options: { value: SubjectController, label: string, validation: ValidationData }[] = [] + const subjects = await this.graph.getSubjects() + for (const subject of subjects) { + + // Check if the subject has a name + if (!this.hasName(subject)) continue + + // Add the subject to options + options.push({ + value: subject, + label: subject.trimmed_name, + validation: await this.validateOption(this.parent as SubjectController, subject) + }) + } + + return options + } + + // --------------------> Validation + + /** + * Check if the relation already exists + * @param parent The parent subject + * @param child The child subject + * @returns Whether the relation already exists + */ + + private async isDuplicate(parent?: SubjectController, child?: SubjectController): Promise { + const subject_relations = await this.graph.getSubjectRelations() + return subject_relations.find(relation => + relation.parent === parent && + relation.child === child + ) !== undefined + } + + /** + * Check if there exists a domain relation that is consistent with this subject relation + * @param parent The parent subject + * @param child The child subject + * @returns Whether the relation is inconsistent + */ + + private async isInconsistent(parent?: SubjectController, child?: SubjectController): Promise { + const domain_relations = await this.graph.getDomainRelations() + return domain_relations.find(relation => + relation.parent?.id === parent?.domain_id && + relation.child?.id === child?.domain_id + ) !== undefined + } + + /** + * Validate an option for this subject relation + * @param parent The parent subject + * @param child The child subject + * @returns The validation data + */ + + private async validateOption(parent?: SubjectController, child?: SubjectController): Promise { + const validation = new ValidationData() + + // Check if the relation is defined + if (!this.isDefined(parent, child)) { + return validation + } + + // Check if the relation is self-referential + if (this.isSelfReferential(parent, child)) { + validation.add({ severity: Severity.error, short: 'Self-referential' }) + } + + // Check if the relation is a duplicate + else if (await this.isDuplicate(parent, child)) { + validation.add({ severity: Severity.error, short: 'Duplicate relation' }) + } + + // Check if the relation is cyclic + else if (await this.isCyclic(parent, child)) { + validation.add({ severity: Severity.error, short: 'Cyclic relation' }) + } + + // Check if the relation is consistent + else if (await this.isInconsistent(parent, child)) { + validation.add({ severity: Severity.warning, short: 'Inconsistent' }) + } + + return validation + } + + /** + * Validate the subject relation + * @returns The validation data + */ + + async validate(): Promise { + const validation = new ValidationData() + + // Check if the parent and child are defined + if (!this.isDefined(this.parent, this.child)) { + validation.add({ + severity: Severity.error, + short: 'Subject relation is not fully defined', + long: 'Both the parent and child subjects must be selected', + tab: 2, + uuid: this.uuid + }) + } + + // Check if the relation is cyclic + else if (await this.isCyclic(this.parent, this.child)) { + validation.add({ + severity: Severity.error, + short: 'Subject relation is cyclic', + long: 'The parent and child subjects are cyclically related', + tab: 2, + uuid: this.uuid + }) + } + + return validation + } +} \ No newline at end of file diff --git a/src/lib/scripts/controllers/UserController.ts b/src/lib/scripts/controllers/UserController.ts new file mode 100644 index 0000000..346f634 --- /dev/null +++ b/src/lib/scripts/controllers/UserController.ts @@ -0,0 +1,375 @@ + +// Internal dependencies +import { + ControllerCache, + ProgramController, + CourseController +} from '$scripts/controllers' + +import type { SerializedUser } from '$scripts/types' + +// Exports +export { UserController } + + +// --------------------> Controller + + +class UserController { + private _program_admins?: ProgramController[] + private _program_editors?: ProgramController[] + private _course_admins?: CourseController[] + private _course_editors?: CourseController[] + + constructor( + public environment: ControllerCache, + public id: number, + public role: string, + public netid: string, + public first_name: string, + public last_name: string, + public email: string, + private _program_admin_ids: number[], + private _program_editor_ids: number[], + private _course_admin_ids: number[], + private _course_editor_ids: number[] + ) { + this.environment.add(this) + } + + get program_admins(): ProgramController[] { + if (this._program_admins) return this._program_admins + throw new Error('UserError: Program admins not loaded') + } + + get program_editors(): ProgramController[] { + if (this._program_editors) return this._program_editors + throw new Error('UserError: Program editors not loaded') + } + + get course_admins(): CourseController[] { + if (this._course_admins) return this._course_admins + throw new Error('UserError: Course admins not loaded') + } + + get course_editors(): CourseController[] { + if (this._course_editors) return this._course_editors + throw new Error('UserError: Course editors not loaded') + } + + /** + * Create a new user + * @param environment Environment to create the user in + * @param netid User netid + * @param first_name User first name + * @param last_name User last name + * @param email User email + * @returns `Promise` The newly created UserController + * @throws `APIError` if the API call fails + */ + + static async create(environment: ControllerCache, netid: string, first_name: string, last_name: string, email: string): Promise { + + // Call API to create a new user + const response = await fetch(`/api/user`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ netid, first_name, last_name, email }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/user POST): ${error}`) + }) + + // Revive the user + const data = await response.json() as SerializedUser + return UserController.revive(environment, data) + } + + /** + * Revive a user from serialized data + * @param environment Environment to revive the user in + * @param data Serialized data to revive + * @returns `UserController` The revived UserController + */ + + static revive(environment: ControllerCache, data: SerializedUser): UserController { + return new UserController(environment, data.id, data.role, data.netid, data.first_name, data.last_name, data.email, data.program_admin, data.program_editor, data.course_admin, data.course_editor) + } + + /** + * Load the user's properties + * @param properties Properties to load + * @throws `UserError` if a property is already loaded or invalid + */ + + async load(...properties: ('program_admins' | 'program_editors' | 'course_admins' | 'course_editors')[]): Promise { + if (properties.length === 0) { + return await this.load('program_admins', 'program_editors', 'course_admins', 'course_editors') + } + + for (const property of properties) { + switch (property) { + case 'program_admins': + if (this._program_admins) throw new Error('UserError: Program admins already loaded') + this._program_admins = await this.environment.getPrograms(this._program_admin_ids) + break + + case 'program_editors': + if (this._program_editors) throw new Error('UserError: Program editors already loaded') + this._program_editors = await this.environment.getPrograms(this._program_editor_ids) + break + + case 'course_admins': + if (this._course_admins) throw new Error('UserError: Course admins already loaded') + this._course_admins = await this.environment.getCourses(this._course_admin_ids) + break + + case 'course_editors': + if (this._course_editors) throw new Error('UserError: Course editors already loaded') + this._course_editors = await this.environment.getCourses(this._course_editor_ids) + break + + default: + throw new Error(`UserError: Property '${property}' is not valid`) + } + } + } + + /** + * Serialize the user + * @returns `SerializedUser` Serialized user + */ + + reduce(): SerializedUser { + return { + id: this.id, + role: this.role, + netid: this.netid, + first_name: this.first_name, + last_name: this.last_name, + email: this.email, + program_admin: this._program_admin_ids, + program_editor: this._program_editor_ids, + course_admin: this._course_admin_ids, + course_editor: this._course_editor_ids + } + } + + /** + * Save the user + * @throws `APIError` if the API call fails + */ + + async save(): Promise { + + // Call API to save the user + await fetch(`/api/user`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(this.reduce()) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/user PUT): ${error}`) + }) + } + + /** + * Delete the user + * @throws `APIError` if the API call fails + */ + + async delete(): Promise { + + // Call API to delete the user + await fetch(`/api/user`, { + method: 'DELETE', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ id: this.id }) + }) + + // Check the response + .catch(error => { + throw new Error(`APIError (/api/user DELETE): ${error}`) + }) + + // Resign everywhere (mirroring is not necessary, as this object will be deleted) + const program_admins = await this.environment.getPrograms(this._program_admin_ids, false) + program_admins.forEach(program => program.unassignAdmin(this, false)) + + const program_editors = await this.environment.getPrograms(this._program_editor_ids, false) + program_editors.forEach(program => program.unassignEditor(this, false)) + + const course_admins = await this.environment.getCourses(this._course_admin_ids, false) + course_admins.forEach(course => course.unassignAdmin(this, false)) + + const course_editors = await this.environment.getCourses(this._course_editor_ids, false) + course_editors.forEach(course => course.unassignEditor(this, false)) + + // Remove from environment + this.environment.remove(this) + } + + /** + * Assign a user as an admin of a program. Resigns the user as an editor if they are one + * @param program Program to assign the user as an admin of + * @param mirror Whether to mirror the assignment + * @throws `UserError` if the user is already an admin of the program + */ + + becomeProgramAdmin(program: ProgramController, mirror: boolean = true): void { + if (this._program_admin_ids.includes(program.id)) + throw new Error(`UserError: User is already an admin of Program with ID ${program.id}`) + this._program_admin_ids.push(program.id) + this._program_admins?.push(program) + + if (this._program_editor_ids.includes(program.id)) { + this.resignAsProgramEditor(program) + } + + if (mirror) { + program.assignAdmin(this, false) + } + } + + /** + * Assign a user as an editor of a program. Resigns the user as an admin if they are one + * @param program Program to assign the user as an editor of + * @param mirror Whether to mirror the assignment + * @throws `UserError` if the user is already an editor of the program + */ + + becomeProgramEditor(program: ProgramController, mirror: boolean = true): void { + if (this._program_editor_ids.includes(program.id)) + throw new Error(`UserError: User is already an editor of Program with ID ${program.id}`) + this._program_editor_ids.push(program.id) + this._program_editors?.push(program) + + if (this._program_admin_ids.includes(program.id)) { + this.resignAsProgramAdmin(program) + } + + if (mirror) { + program.assignEditor(this, false) + } + } + + /** + * Assign a user as an admin of a course. Resigns the user as an editor if they are one + * @param course Course to assign the user as an admin of + * @param mirror Whether to mirror the assignment + * @throws `UserError` if the user is already an admin of the course + */ + + becomeCourseAdmin(course: CourseController, mirror: boolean = true): void { + if (this._course_admin_ids.includes(course.id)) + throw new Error(`UserError: User is already an admin of Course with ID ${course.id}`) + this._course_admin_ids.push(course.id) + this._course_admins?.push(course) + + if (this._course_editor_ids.includes(course.id)) { + this.resignAsCourseEditor(course) + } + + if (mirror) { + course.assignAdmin(this, false) + } + } + + /**` + * Assign a user as an editor of a course. Resigns the user as an admin if they are one + * @param course Course to assign the user as an editor of + * @param mirror Whether to mirror the assignment + * @throws `UserError` if the user is already an editor of the course + */ + + becomeCourseEditor(course: CourseController, mirror: boolean = true): void { + if (this._course_editor_ids.includes(course.id)) + throw new Error(`UserError: User is already an editor of Course with ID ${course.id}`) + this._course_editor_ids.push(course.id) + this._course_editors?.push(course) + + if (this._course_admin_ids.includes(course.id)) { + this.resignAsCourseAdmin(course) + } + + if (mirror) { + course.assignEditor(this, false) + } + } + + /** + * Unassign a user as an admin of a program + * @param program Program to unassign the user as an admin of + * @param mirror Whether to mirror the unassignment + * @throws `UserError` if the user is not an admin of the program + */ + + resignAsProgramAdmin(program: ProgramController, mirror: boolean = true): void { + if (!this._program_admin_ids.includes(program.id)) + throw new Error(`UserError: User is not an admin of Program with ID ${program.id}`) + this._program_admin_ids = this._program_admin_ids.filter(id => id !== program.id) + this._program_admins = this._program_admins?.filter(admin => admin.id !== program.id) + + if (mirror) { + program.unassignAdmin(this, false) + } + } + + /** + * Unassign a user as an editor of a program + * @param program Program to unassign the user as an editor of + * @param mirror Whether to mirror the unassignment + * @throws `UserError` if the user is not an editor of the program + */ + + resignAsProgramEditor(program: ProgramController, mirror: boolean = true): void { + if (!this._program_editor_ids.includes(program.id)) + throw new Error(`UserError: User is not an editor of Program with ID ${program.id}`) + this._program_editor_ids = this._program_editor_ids.filter(id => id !== program.id) + this._program_editors = this._program_editors?.filter(editor => editor.id !== program.id) + + if (mirror) { + program.unassignEditor(this, false) + } + } + + /** + * Unassign a user as an admin of a course + * @param course Course to unassign the user as an admin of + * @param mirror Whether to mirror the unassignment + * @throws `UserError` if the user is not an admin of the course + */ + + resignAsCourseAdmin(course: CourseController, mirror: boolean = true): void { + if (!this._course_admin_ids.includes(course.id)) + throw new Error(`UserError: User is not an admin of Course with ID ${course.id}`) + this._course_admin_ids = this._course_admin_ids.filter(id => id !== course.id) + this._course_admins = this._course_admins?.filter(admin => admin.id !== course.id) + + if (mirror) { + course.unassignAdmin(this, false) + } + } + + /** + * Unassign a user as an editor of a course + * @param course Course to unassign the user as an editor of + * @param mirror Whether to mirror the unassignment + * @throws `UserError` if the user is not an editor of the course + */ + + resignAsCourseEditor(course: CourseController, mirror: boolean = true): void { + if (!this._course_editor_ids.includes(course.id)) + throw new Error(`UserError: User is not an editor of Course with ID ${course.id}`) + this._course_editor_ids = this._course_editor_ids.filter(id => id !== course.id) + this._course_editors = this._course_editors?.filter(editor => editor.id !== course.id) + + if (mirror) { + course.unassignEditor(this, false) + } + } +} diff --git a/src/lib/scripts/controllers/index.ts b/src/lib/scripts/controllers/index.ts new file mode 100644 index 0000000..0f6eb19 --- /dev/null +++ b/src/lib/scripts/controllers/index.ts @@ -0,0 +1,10 @@ + +export { ControllerCache } from './ControllerCache' +export { ProgramController } from './ProgramController' +export { CourseController } from './CourseController' +export { FieldController, DomainController, SubjectController } from './FieldControllers' +export { GraphController, SortOption } from './GraphController' +export { LectureController } from './LectureController' +export { RelationController, DomainRelationController, SubjectRelationController } from './RelationControllers' +export { UserController } from './UserController' +export { LinkController } from './LinkController' \ No newline at end of file diff --git a/src/lib/scripts/d3/index.ts b/src/lib/scripts/d3/index.ts deleted file mode 100644 index 17736d6..0000000 --- a/src/lib/scripts/d3/index.ts +++ /dev/null @@ -1,5 +0,0 @@ - -export { GraphSVG, View, State } from './GraphSVG' -export { FieldSVG } from './FieldSVG' -export { RelationSVG } from './RelationSVG' -export { OverlaySVG } from './OverlaySVG' \ No newline at end of file diff --git a/src/lib/scripts/entities/Course.ts b/src/lib/scripts/entities/Course.ts deleted file mode 100644 index ffa4c4f..0000000 --- a/src/lib/scripts/entities/Course.ts +++ /dev/null @@ -1,216 +0,0 @@ - -// Internal imports -import { ValidationData, Severity } from "./Validation" - -// Exports -export { Course, AssignedUser, Permissions } -export type { SerializedCourse, SerializedAssignedUser } - - -// --------------------> Types - -type SerializedAssignedUser = { - id: ID, - netid: string, - first_name: string, - last_name: string, - email?: string, - permissions: Permissions -} - -type SerializedCourse = { - code: string, - name: string, - users: SerializedAssignedUser[] -} - -enum Permissions { - read, - write, - admin -} - - -// --------------------> Classes - -type ID = number; - -class AssignedUser { - constructor( - public course: Course, - public id: ID, - public netid: string, - public index: number, - public first_name: string, - public last_name: string, - public permissions?: Permissions - ) { } - - static create(course: Course) { - /* Create a new assigned user */ - // TODO make not this - - const user = new AssignedUser( - course, - 1, - 'jsmith', - course.users.length, - 'John', - 'Smith' - ) - course.users.push(user) - return user - } - - validate(): ValidationData { - /* Validate the assigned user */ - - const response = new ValidationData() - - // Check if the user name is valid - if (this.first_name === '' || this.last_name === '') { - response.add({ - severity: Severity.error, - short: 'User must have a name', - tab: 1, - anchor: `user-${this.id}` - }) - } - - // Check if the user has permissions - if (this.permissions === undefined) { - response.add({ - severity: Severity.error, - short: 'User must have permissions', - tab: 1, - anchor: `user-${this.id}` - }) - } - - return response - } - - reduce(): SerializedAssignedUser { - /* Reduce the assigned user to a POJO */ - return { - id: this.id, - netid: this.netid, - first_name: this.first_name, - last_name: this.last_name, - permissions: this.permissions! - } - } - - delete() { - /* Delete the assigned user */ - - this.course.users = this.course.users.filter(user => user !== this) - } -} - -class Course { - constructor( - public code: string, - public name: string, - public users: AssignedUser[] = [], - ) { } - - get permission_options() { - /* Get the permission options */ - - const validation = new ValidationData() - - return [ - { name: 'Read', value: Permissions.read, validation }, - { name: 'Write', value: Permissions.write, validation }, - { name: 'Admin', value: Permissions.admin, validation } - ] - } - - static revive(data: SerializedCourse) { - /* Load the course from a POGO */ - - const course = new Course(data.code, data.name) - for (const user_data of data.users) { - const user = AssignedUser.create(course) - user.id = user_data.id - user.netid = user_data.netid - user.first_name = user_data.first_name - user.last_name = user_data.last_name - user.permissions = user_data.permissions - } - - return course - } - - validate(): ValidationData { - /* Validate the course */ - - const response = new ValidationData() - - // Check if the course code is valid - if (this.code === '') { - response.add({ - severity: Severity.error, - short: 'Course has no code', - tab: 0, - anchor: 'code' - }) - } - - // Check if the course name is valid - if (this.name === '') { - response.add({ - severity: Severity.error, - short: 'Course has no name', - tab: 0, - anchor: 'name' - }) - } - - // Check if the course has users - if (this.users.length === 0) { - response.add({ - severity: Severity.error, - short: 'Course has no users', - tab: 1, - anchor: 'users' - }) - } - - // Check if the course has an admin - else if (!this.users.some(user => user.permissions === Permissions.admin)) { - response.add({ - severity: Severity.error, - short: 'Course has no admin', - tab: 1, - anchor: '' - }) - } - - // Validate the users - for (const user of this.users) { - response.add(user.validate()) - } - - return response - } - - reduce(): SerializedCourse { - /* Reduce the course to a POJO */ - - return { - code: this.code, - name: this.name, - users: this.users.map(user => user.reduce()) - } - } - - save() { - /* Save the course */ - } - - delete() { - /* Delete the course */ - } -} diff --git a/src/lib/scripts/entities/Fields.ts b/src/lib/scripts/entities/Fields.ts deleted file mode 100644 index d93b9d6..0000000 --- a/src/lib/scripts/entities/Fields.ts +++ /dev/null @@ -1,471 +0,0 @@ - -// External imports -import * as uuid from 'uuid' - -// Internal imports -import { ValidationData, Severity } from './Validation' -import { Graph } from './Graph' - -import * as settings from '../settings' -import { styles } from '../settings' - -// Exports -export { Field, Domain, Subject } -export type { SerializedDomain, SerializedSubject } - - -// --------------------> Types - - -type ID = number - -type SerializedDomain = { - id: ID, - x: number, - y: number, - style: string, - name: string, - parents: ID[], - children: ID[] -} - -type SerializedSubject = { - id: ID, - x: number, - y: number, - domain?: ID, - name: string, - parents: ID[], - children: ID[] -} - - -// --------------------> Classes - - -abstract class Field { - fx?: number // The locked x-coordinate of this field - fy?: number // The locked y-coordinate of this field - - constructor( - public graph: Graph, // The graph this field belongs to - public anchor: string, // The anchor of this field, unique for every DOM element, used for finding errors and d3 selections - public index: number, // The index of this field in the list of its type, based on creation order, consistent after sorting, deleting etc - public id: ID, // The ID of this field in the database, unique among its type, NOT among all fields - public x: number, // The current x-coordinate of this field - public y: number, // The current y-coordinate of this field - public name: string, // The name of this field - public parents: T[], // The parents of this field - public children: T[], // The children of this field - ) { - /* Create a new field */ - - this.fx = x - this.fy = y - } - - protected hasName(field: Domain | Subject): boolean { - /* Check if the name of a field is undefined */ - - return field.name !== '' - } - - protected findOriginal(list: S[], value: S, key: (item: S) => T): number { - /* Find the original item in a list - * Returns -1 if value doesn't exist, or isnt a duplicate - * Returns the index of the first duplicate otherwise - */ - - const first = list.findIndex(item => key(item) === key(value)) - const index = list.indexOf(value, first + 1) - return index === -1 ? -1 : first - } - - abstract get style(): string | undefined - abstract get color(): string - abstract validate(): ValidationData - abstract delete(): void -} - -class Domain extends Field { - private _style?: string - - constructor( - graph: Graph, - index: number, - id: ID, - x: number = 0, - y: number = 0, - style?: string, - name: string = '', - parents: Domain[] = [], - children: Domain[] = [] - ) { - super(graph, uuid.v4(), index, id, x, y, name, parents, children) - this.style = style - } - - get subjects(): Subject[] { - /* Return the subjects of this domain */ - - const subjects = [] - for (const subject of this.graph.subjects) { - if (subject.domain === this) { - subjects.push(subject) - } - } - - return subjects - } - - get color(): string { - /* Return the preview color of this domain */ - - return this.style ? styles[this.style].stroke : 'transparent' - } - - get style(): string | undefined { - /* Return the style of this domain */ - - return this._style - } - - set style(style: string | undefined) { - /* Set the style of this domain */ - - this._style = style - } - - get style_options() { - /* Return the style options of this domain */ - - const options = [] - for (const [style, value] of Object.entries(styles)) { - const validation = new ValidationData() - - // Check if the style is already used - if (this.graph.domains.some(domain => domain.style === style && domain !== this)) { - validation.add({ severity: Severity.warning, short:'Duplicate style' }) - } - - options.push({ - name: value.display_name, - value: style, - validation - }) - } - - return options - } - - static create(graph: Graph, id: ID): Domain { - /* Create a new domain */ - - const domain = new Domain( - graph, graph.domains.length, id, - 0, 0, // TODO find non-overlapping x and y - graph.nextDomainStyle() - ) - graph.domains.push(domain) - return domain - } - - private hasStyle(): boolean { - /* Check if the style of a domain is undefined */ - - return this.style !== undefined - } - - private hasSubjects(): boolean { - /* Check if the domain has subjects */ - - return this.subjects.length > 0 - - } - - validate(): ValidationData { - /* Validate this domain */ - - const response = new ValidationData() - - // Check if the domain has a name - if (!this.hasName(this)) { - response.add({ - severity: Severity.error, - short: 'Domain has no name', - tab: 1, - anchor: this.anchor - }) - } - - else { - - // Check if the domain has a unique name - const first = this.findOriginal(this.graph.domains, this, domain => domain.name) - if (first !== -1) { - response.add({ - severity: Severity.error, - short: 'Domain has duplicate name', - long: `Name first used by Domain nr. ${first + 1}`, - tab: 1, - anchor: this.anchor - }) - } - - // Check if the name is too long - if (this.name.length > settings.FIELD_MAX_CHARS) { - response.add({ - severity: Severity.error, - short: 'Domain name too long', - long: `Name exceeds ${settings.FIELD_MAX_CHARS} characters`, - tab: 1, - anchor: this.anchor - }) - } - } - - // Check if the domain has a style - if (!this.hasStyle()) { - response.add({ - severity: Severity.error, - short: 'Domain has no style', - tab: 1, - anchor: this.anchor - }) - } - - else { - - // Check if the domain has a unique style - const first = this.findOriginal(this.graph.domains, this, domain => domain.style) - if (first !== -1) { - response.add({ - severity: Severity.warning, - short: 'Domain has duplicate style', - long: `Style first used by Domain nr. ${first + 1}`, - tab: 1, - anchor: this.anchor - }) - } - } - - // Check if the domain has subjects - if (!this.hasSubjects()) { - response.add({ - severity: Severity.warning, - short: 'Domain has no subjects', - tab: 1, - anchor: this.anchor - }) - } - - return response - } - - reduce(): SerializedDomain { - /* Serialize domain to a POJO */ - - return { - id: this.id, - x: this.x, - y: this.y, - style: this.style!, - name: this.name, - parents: this.parents.map(parent => parent.id), - children: this.children.map(child => child.id) - } - } - - async delete(): Promise { - /* Delete this domain */ - - // Shift indexes - for (const domain of this.graph.domains) { - if (domain.index > this.index) { - domain.index-- - } - } - - // Delete relations - for (const relation of this.graph.domain_relations) { - if (relation.parent === this || relation.child === this) { - relation.delete() - } - } - - // Unset subjects with this domain - for (const subject of this.graph.subjects) { - if (subject.domain === this) { - subject.domain = undefined - } - } - - // Call API to delete domain (should cascade automatically?) - // TODO: check if this is the case - const res = await fetch(`/api/domain/${this.id}`, { method: 'DELETE' }); - - // Remove this domain from the graph - this.graph.domains = this.graph.domains.filter(domain => domain !== this) - } -} - -class Subject extends Field { - domain?: Domain - - constructor( - graph: Graph, - index: number, - id: ID, - x: number = 0, - y: number = 0, - domain?: Domain, - name: string = '', - parents: Subject[] = [], - children: Subject[] = [] - ) { - super(graph, uuid.v4(), index, id, x, y, name, parents, children) - this.domain = domain - } - - get color(): string { - /* Return the preview color of this subject */ - - return this.domain?.color || 'transparent' - } - - get style(): string | undefined { - /* Return the style of this subject */ - - return this.domain?.style - } - - get domain_options() { - /* Return the domain options of this subject */ - - const options = [] - for (const domain of this.graph.domains) { - - // Check if the domain has a name - if (!this.hasName(domain)) continue - - options.push({ - name: domain.name, - value: domain, - validation: ValidationData.success() - }) - } - - return options - } - - private hasDomain(): boolean { - /* Check if the domain of a subject is undefined */ - - return this.domain !== undefined - } - - static create(graph: Graph, id: ID) { - /* Create a new subject */ - - const subject = new Subject(graph, graph.subjects.length, id) - graph.subjects.push(subject) - return subject - } - - validate(): ValidationData { - /* Validate this subject */ - - const response = new ValidationData() - - // Check if the subject has a name - if (!this.hasName(this)) { - response.add({ - severity: Severity.error, - short: 'Subject has no name', - tab: 2, - anchor: this.anchor - }) - } - - else { - - // Check if the name is unique - const first = this.findOriginal(this.graph.subjects, this, subject => subject.name) - if (first !== -1) { - response.add({ - severity: Severity.error, - short: 'Subject has duplicate name', - long: `Name first used by Subject nr. ${first + 1}`, - tab: 2, - anchor: this.anchor - }) - } - - // Check if the name is too long - if (this.name.length > settings.FIELD_MAX_CHARS) { - response.add({ - severity: Severity.error, - short: 'Subject name too long', - long: `Name exceeds ${settings.FIELD_MAX_CHARS} characters`, - tab: 2, - anchor: this.anchor - }) - } - } - - // Check if the subject has a domain - if (!this.hasDomain()) { - response.add({ - severity: Severity.error, - short: 'Subject has no domain', - tab: 2, - anchor: this.anchor - }) - } - - return response - } - - reduce(): SerializedSubject { - /* Serialize subject to a POJO */ - - return { - id: this.id, - x: this.x, - y: this.y, - domain: this.domain ? this.domain.id : undefined, - name: this.name, - parents: this.parents.map(parent => parent.id), - children: this.children.map(child => child.id) - } - } - - async delete(): Promise { - /* Delete this subject */ - - // Shift indexes - for (const subject of this.graph.subjects) { - if (subject.index > this.index) { - subject.index-- - } - } - - // Delete relations - for (const relation of this.graph.subject_relations) { - if (relation.parent === this || relation.child === this) { - relation.delete() - } - } - - // Remove subject from lectures - for (const lecture of this.graph.lectures) { - lecture.lecture_subjects = lecture.lecture_subjects.filter(ls => ls.subject !== this) - } - - // Call API to delete subject - await fetch(`/api/subject/${this.id}`, { method: 'DELETE' }); - - // Remove this subject from the graph - this.graph.subjects = this.graph.subjects.filter(subject => subject !== this) - } -} diff --git a/src/lib/scripts/entities/Graph.ts b/src/lib/scripts/entities/Graph.ts deleted file mode 100644 index 4d045df..0000000 --- a/src/lib/scripts/entities/Graph.ts +++ /dev/null @@ -1,284 +0,0 @@ -// Internal imports -import { ValidationData, Severity } from './Validation' -import { Domain, Subject } from './Fields' -import { DomainRelation, SubjectRelation } from './Relations' -import { Lecture, LectureSubject } from './Lecture' - -import type { SerializedLecture } from './Lecture' -import type { SerializedSubject } from './Fields' -import type { SerializedDomain } from './Fields' - -import { styles } from '../settings' - -// Exports -export { Graph, SortOption } -export type { SerializedGraph, SortOptions } - - -// --------------------> Types - - -type ID = number - -type SerializedGraph = { - id: ID, - name: string, - domains: SerializedDomain[], - subjects: SerializedSubject[], - lectures: SerializedLecture[] -} - -type SortOptions = number -enum SortOption { - domains = 0b10000000, - subjects = 0b01000000, - relations = 0b00100000, - name = 0b00010000, - style = 0b00001000, - domain = 0b00000100, - parent = 0b00000010, - child = 0b00000001 - -} - - -// --------------------> Classes - - -class Graph { - constructor( - public id: ID, - public name: string = '', - public domains: Domain[] = [], - public subjects: Subject[] = [], - public lectures: Lecture[] = [] - ) { } - - // Inferred - domain_relations: DomainRelation[] = [] - subject_relations: SubjectRelation[] = [] - - get lecture_options() { - /* Return the options of the lecture */ - - const options = [] - for (const lecture of this.lectures) { - options.push({ - name: lecture.name, - value: lecture, - validation: ValidationData.success() - }) - } - - return options - } - - static revive(data: SerializedGraph) { - /* Revive graph from a POJO */ - - const graph = new Graph(data.id, data.name) - - // Define domains - for (const domain_data of data.domains) { - graph.domains.push( - new Domain( - graph, - graph.domains.length, - domain_data.id, - domain_data.x, - domain_data.y, - domain_data.style ?? undefined, - domain_data.name ?? '' - ) - ) - } - - // Build domain relations - for (const parent_data of data.domains) { - const parent = graph.domains.find(domain => domain.id === parent_data.id) - if (!parent) continue - - for (const child_id of parent_data.children) { - const child = graph.domains.find(domain => domain.id === child_id) - if (!child) continue - - const relation = DomainRelation.create(graph) - relation.parent = parent - relation.child = child - } - } - - // Define subjects - for (const subject_data of data.subjects) { - const domain = graph.domains.find(domain => domain.id === subject_data.domain) - - graph.subjects.push( - new Subject( - graph, - graph.subjects.length, - subject_data.id, - subject_data.x, - subject_data.y, - domain, - subject_data.name ?? '' - ) - ) - } - - // Build subject relations - for (const parent_data of data.subjects) { - const parent = graph.subjects.find(subject => subject.id === parent_data.id) - if (!parent) continue - - for (const child_id of parent_data.children) { - const child = graph.subjects.find(subject => subject.id === child_id) - if (!child) continue - - const relation = SubjectRelation.create(graph) - relation.parent = parent - relation.child = child - } - } - - // Define lectures - for (const lecture_data of data.lectures) { - const lecture = new Lecture( - graph, - graph.lectures.length, - lecture_data.id, - lecture_data.name ?? '' - ) - - graph.lectures.push(lecture) - - // Define lecture subjects - for (const subject_id of lecture_data.subjects) { - const subject = graph.subjects.find(subject => subject.id === subject_id) - if (!subject) continue - - const lecture_subject = LectureSubject.create(lecture) - lecture_subject.subject = subject - } - } - - return graph - } - - private hasName(): boolean { - /* Check if the graph has a name */ - - return this.name !== '' - } - - nextDomainStyle(): string | undefined { - /* Return the next available domain style */ - - const used_styles = this.domains.map(domain => domain.style) - return Object.keys(styles).find(style => !used_styles.includes(style)) - } - - sort(options: SortOptions, descending: boolean) { - /* Sort the graph */ - - let key: (item: any) => string - if (options & SortOption.relations) { - if (options & SortOption.parent) { - key = relation => relation.parent?.name ?? '' - } else if (options & SortOption.child) { - key = relation => relation.child?.name ?? '' - } else return - } else if (options & SortOption.name) { - key = field => field.name - } else if (options & SortOption.style) { - key = domain => domain.style ? styles[domain.style].display_name : '' - } else if (options & SortOption.domain) { - key = subject => subject.domain?.name ?? '' - } else return - - if (options & SortOption.relations) { - if (options & SortOption.domains) { - this.domain_relations.sort((a, b) => key(b).localeCompare(key(a))) - if (descending) this.domain_relations.reverse() - } else if (options & SortOption.subjects) { - this.subject_relations.sort((a, b) => key(b).localeCompare(key(a))) - if (descending) this.subject_relations.reverse() - } - } else { - if (options & SortOption.domains) { - this.domains.sort((a, b) => key(b).localeCompare(key(a))) - if (descending) this.domains.reverse() - } else if (options & SortOption.subjects) { - this.subjects.sort((a, b) => key(b).localeCompare(key(a))) - if (descending) this.subjects.reverse() - } - } - } - - validate(): ValidationData { - /* Validate the graph */ - - const response = new ValidationData() - - // Check if the graph has a name - if (!this.hasName()) { - response.add({ - severity: Severity.error, - short: 'Graph has no name', - long: 'The graph must have a name', - tab: 0, - anchor: 'name' - }) - } - - // Validate domains, subjects and lectures - for (const domain of this.domains) - response.add(domain.validate()) - for (const relation of this.domain_relations) - response.add(relation.validate()) - for (const subject of this.subjects) - response.add(subject.validate()) - for (const relation of this.subject_relations) - response.add(relation.validate()) - for (const lecture of this.lectures) - response.add(lecture.validate()) - - return response - } - - reduce(): SerializedGraph { - /* Reduce graph to a POJO */ - - return { - id: this.id, - name: this.name, - domains: this.domains.map(domain => domain.reduce()), - subjects: this.subjects.map(subject => subject.reduce()), - lectures: this.lectures.map(lecture => lecture.reduce()) - } - } - - async save() { - /* Save the graph to the database */ - - const response = await fetch(`/api/graph/${this.id}`, { - method: 'PUT', - body: JSON.stringify(this.reduce()) - }); - - if (response.ok) { - console.log('[*] Graph saved!'); - } - else { - const message = await response.text(); - console.error(`Failed to save graph: ${message}`); - } - } - - delete() { - /* Delete the graph from the database */ - } - - // TODO: Temp because these were used in mocked data in course overview - hasLinks = () => true - isVisible = () => true -} diff --git a/src/lib/scripts/entities/Lecture.ts b/src/lib/scripts/entities/Lecture.ts deleted file mode 100644 index 91b12fb..0000000 --- a/src/lib/scripts/entities/Lecture.ts +++ /dev/null @@ -1,282 +0,0 @@ - -// External imports -import * as uuid from 'uuid' - -// Internal imports -import { ValidationData, Severity } from './Validation' -import { Graph } from './Graph' -import { Subject } from './Fields' -import { SubjectRelation } from './Relations' - -// Exports -export { Lecture, LectureSubject } -export type { SerializedLecture } - - -// --------------------> Type - -type ID = number - -type SerializedLecture = { - id: ID, - name: string, - subjects: ID[] -} - -// --------------------> Classes - - -class LectureSubject { - constructor( - public lecture: Lecture, - public subject?: Subject - ) { } - - static create(lecture: Lecture): LectureSubject { - /* Create a new lecture subject */ - - const lecture_subject = new LectureSubject(lecture) - lecture.lecture_subjects.push(lecture_subject) - return lecture_subject - } - - get color(): string { - /* Return the color of the subject */ - - return this.subject?.color || 'transparent' - } - - get options() { - /* Return the options of the subject */ - - const options = [] - for (const subject of this.lecture.graph.subjects) { - if (subject.name === '') continue - - // Check if the subject is already in the lecture - const validation = new ValidationData() - if (this.lecture.present.includes(subject)) { - validation.add({ severity: Severity.error, short: 'Duplicate subject'}) - } - - options.push({ - name: subject.name, - value: subject, - validation - }) - } - - return options - } - - delete() { - /* Delete this lecture subject */ - - this.lecture.lecture_subjects = this.lecture.lecture_subjects.filter(subject => subject !== this) - } -} - -class Lecture { - anchor: string - - constructor( - public graph: Graph, - public index: number, - public id: ID, - public name: string = '', - public lecture_subjects: LectureSubject[] = [] - ) { - /* Create a new lecture */ - - this.anchor = uuid.v4() - } - - static create(graph: Graph, id: ID) { - const lecture = new Lecture(graph, graph.lectures.length, id); - graph.lectures.push(lecture); - return lecture; - } - - get size(): number { - /* Return the size of the lecture */ - - return Math.max( - this.past.length, - this.present.length, - this.future.length - ) - } - - get past(): Subject[] { - /* Return the past of this lecture */ - - const past: Subject[] = [] - for (const lecture_subject of this.lecture_subjects) { - if (!lecture_subject.subject) continue - for (const parent of lecture_subject.subject.parents) { - if (this.present.includes(parent) || past.includes(parent)) - continue - past.push(parent) - } - } - - return past - } - - get present(): Subject[] { - /* Return the present of this lecture */ - - const present: Subject[] = [] - for (const lecture_subject of this.lecture_subjects) { - if (!lecture_subject.subject) continue - present.push(lecture_subject.subject) - } - - return present - } - - get future(): Subject[] { - /* Return the future of this lecture */ - - const future: Subject[] = [] - for (const lecture_subject of this.lecture_subjects) { - if (!lecture_subject.subject) continue - for (const child of lecture_subject.subject.children) { - if (this.present.includes(child) || future.includes(child)) - continue - future.push(child) - } - } - - return future - } - - get subjects(): Subject[] { - /* Return the fields of this lecture */ - - return this.past - .concat(this.present) - .concat(this.future) - } - - get relations(): SubjectRelation[] { - /* Return the relations of this lecture */ - - const relations: SubjectRelation[] = [] - for (const subject of this.present) { - for (const relation of this.graph.subject_relations) { - if (relation.child === subject || relation.parent === subject) { - relations.push(relation) - } - } - } - - return relations - } - - private hasName(): boolean { - /* Check if the lecture has a name */ - - return this.name !== '' - } - - private hasSubjects(): boolean { - /* Check if the lecture has subjects */ - - return this.lecture_subjects.length > 0 - } - - private isDefined(): boolean { - /* Check if the lecture is defined */ - - return this.lecture_subjects.every(lecture_subject => lecture_subject.subject) - } - - private findOriginal(list: S[], value: S, key: (item: S) => T): number { - /* Find the original item in a list - * Returns -1 if value doesn't exist, or isnt a duplicate - * Returns the index of the first duplicate otherwise - */ - - const first = list.findIndex(item => key(item) === key(value)) - const index = list.indexOf(value, first + 1) - return index === -1 ? -1 : first - } - - validate(): ValidationData { - /* Validate the lecture */ - - const response = new ValidationData() - - // Check if the lecture has a name - if (!this.hasName()){ - response.add({ - severity: Severity.error, - short: 'Lecture has no name', - tab: 3, - anchor: this.anchor - }) - } - - // Check if the name is unique - else { - const first = this.findOriginal(this.graph.lectures, this, lecture => lecture.name) - if (first !== -1) { - response.add({ - severity: Severity.error, - short: 'Duplicate lecture name', - long: `Name first used by Lecture nr. ${first + 1}`, - tab: 3, - anchor: this.anchor - }) - } - } - - // Check if the lecture has subjects - if (!this.hasSubjects()) { - response.add({ - severity: Severity.error, - short: 'Lecture has no subjects', - tab: 3, - anchor: this.anchor - }) - } - - // TODO maybe just save defined subjects and remove this error - // Check if the lecture has undefined subjects - else if (!this.isDefined()) { - response.add({ - severity: Severity.error, - short: 'Lecture has undefined subjects', - long: 'Make sure all subjects are defined', - tab: 3, - anchor: this.anchor - }) - } - - return response - } - - reduce(): SerializedLecture { - /* Serialize lecture to a POJO */ - - return { - id: this.id, - name: this.name, - subjects: this.present.map(subject => subject.id) - } - } - - delete() { - /* Delete this lecture */ - - // Shift indexes - for (const lecture of this.graph.lectures) { - if (lecture.index > this.index) - lecture.index-- - } - - // Remove this lecture from the graph - this.graph.lectures = this.graph.lectures.filter(lecture => lecture !== this) - } -} diff --git a/src/lib/scripts/entities/Relations.ts b/src/lib/scripts/entities/Relations.ts deleted file mode 100644 index 6aee8e6..0000000 --- a/src/lib/scripts/entities/Relations.ts +++ /dev/null @@ -1,405 +0,0 @@ - -// Extrnal imports -import * as uuid from 'uuid' - -// Internal imports -import { ValidationData, Severity } from './Validation' -import { Domain, Subject } from './Fields' -import { Graph } from './Graph' - -// Exports -export { Relation, DomainRelation, SubjectRelation } - - -// --------------------> Classes - - -abstract class Relation { - constructor ( - public graph: Graph, // The graph the relation belongs to - public anchor: string, // The anchor of the relation, unique for every DOM element, used for finding errors and d3 selection - public index: number, // The index of the relation in the list of its type, based on creation order, consistent after sorting, deleting etc - private _parent?: T, // The parent of the relation, exposed setter automatically updates field parents/children - private _child?: T // The child of the relation, exposed setter automatically updates field parents/children - ) { } - - get parent(): T | undefined { - return this._parent - } - - set parent(parent: T | undefined) { - if (this.parent === parent) return - - // Update parent and child references - if (this.child) { - if (this.parent) { - this.child.parents = this.child.parents.filter(field => field !== this.parent) as Domain[] | Subject[] - this.parent.children = this.parent.children.filter(field => field !== this.child) as Domain[] | Subject[] - } - - if (parent) { - this.child.parents = [...this.child.parents, parent] as Domain[] | Subject[] - parent.children = [...parent.children, this.child] as Domain[] | Subject[] - } - } - - this._parent = parent - } - - get parent_color(): string { - return this.parent?.color || 'transparent' - } - - get child(): T | undefined { - return this._child - } - - set child(child: T | undefined) { - if (this.child === child) return - - // Update parent and child references - if (this.parent) { - if (this.child) { - this.parent.children = this.parent.children.filter(field => field !== this.child) as Domain[] | Subject[] - this.child.parents = this.child.parents.filter(field => field !== this.parent) as Domain[] | Subject[] - } - - if (child) { - this.parent.children = [...this.parent.children, child] as Domain[] | Subject[] - child.parents = [...child.parents, this.parent] as Domain[] | Subject[] - } - } - - this._child = child - } - - get child_color(): string { - return this.child?.color || 'transparent' - } - - protected hasName(field: Domain | Subject) { - /* Check if the field has a name */ - - return field.name !== '' - } - - protected isDefined(...values: (any | undefined)[]): boolean { - /* Check if the relation is defined */ - - return values.every(value => value !== undefined) - } - - protected isCyclic(parent?: T, child?: T): boolean { - /* Depth first check if the relation is cyclic */ - - let stack: (Domain | Subject)[] = [child!] - while (stack.length > 0) { - const current = stack.pop()! - if (current === parent) return true - stack.push(...current.children) - } - - return false - } - - protected isSelfReferential(parent?: T, child?: T): boolean { - /* Check if the relation is self-referential */ - - if (!this.isDefined(parent, child)) return false - return parent === child - } - - abstract get parent_options(): any[] - abstract get child_options(): any[] - abstract validate(): ValidationData - abstract delete(): void -} - -class DomainRelation extends Relation { - get parent_options() { - /* Return the parent options for this domain relation */ - - const options = [] - for (const domain of this.graph.domains) { - - // Check if the domain has a name - if (!this.hasName(domain)) continue - - // Add the domain to options - options.push({ - name: domain.name, - value: domain, - validation: this.validateOption(domain, this.child) - }) - } - - return options - } - - get child_options() { - /* Return the child options for this domain relation */ - - const options = [] - for (const domain of this.graph.domains) { - - // Check if the domain has a name - if (!this.hasName(domain)) continue - - // Add the domain to options - options.push({ - name: domain.name, - value: domain, - validation: this.validateOption(this.parent, domain) - }) - } - - return options - } - - static create(graph: Graph): DomainRelation { - /* Create a new domain relation */ - - const relation = new DomainRelation(graph, uuid.v4(), graph.domain_relations.length) - graph.domain_relations.push(relation) - return relation - } - - private isDuplicate(parent?: Domain, child?: Domain): boolean { - /* Check if the relation is a duplicate */ - - return -1 !== this.graph.domain_relations.findIndex( - relation => relation !== this && - relation.parent === parent && - relation.child === child - ) - } - - private isInconsistent(parent?: Domain, child?: Domain): boolean { - /* Check if the relation is consistent */ - - return this.graph.subject_relations.every(relation => - relation.parent?.domain !== parent || - relation.child?.domain !== child - ) - } - - private validateOption(parent?: Domain, child?: Domain): ValidationData { - const validation = new ValidationData() - - // Check if the relation is defined - if (!this.isDefined(parent, child)) - return validation - - // Check if the relation is self-referential - if (this.isSelfReferential(parent, child)) - validation.add({ severity: Severity.error, short: 'Self-referential'}) - - // Check if the relation is a duplicate - else if (this.isDuplicate(parent, child)) - validation.add({ severity: Severity.error, short: 'Duplicate relation'}) - - // Check if the relation is cyclic - else if (this.isCyclic(parent, child)) - validation.add({ severity: Severity.error, short: 'Cyclic relation'}) - - // Check if the relation is consistent - else if (this.isInconsistent(parent, child)) - validation.add({ severity: Severity.warning, short: 'Inconsistent'}) - - return validation - } - - validate(): ValidationData { - /* Validate this domain relation */ - - const response = new ValidationData() - - // Check if the relation is defined - if (!this.isDefined(this.parent, this.child)) { - response.add({ - severity: Severity.error, - short: 'Domain relation is not fully defined', - long: 'Both the parent and child domains must be selected', - tab: 1, - anchor: this.anchor - }) - } - - // Check if the relation is consistent - if (this.isInconsistent(this.parent, this.child)) { - response.add({ - severity: Severity.warning, - short: 'Domain relation is inconsistent', - long: 'The subjects of these domains are not related', - tab: 1, - anchor: this.anchor - }) - } - - return response - } - - delete(): void { - /* Delete this domain relation */ - - // Shift indexes - for (const relation of this.graph.domain_relations) { - if (relation.index > this.index) { - relation.index-- - } - } - - // Remove references in the parent and child - if (this.isDefined(this.parent, this.child)) { - this.parent!.children = this.parent!.children.filter(child => child !== this.child) - this.child!.parents = this.child!.parents.filter(parent => parent !== this.parent) - } - - // Remove this relation from the graph - this.graph.domain_relations = this.graph.domain_relations.filter(relation => relation !== this) - } -} - -class SubjectRelation extends Relation { - get parent_options() { - /* Return the parent options for this subject relation */ - - const options = [] - for (const subject of this.graph.subjects) { - - // Check if the subject has a name - if (!this.hasName(subject)) continue - - // Add the subject to options - options.push({ - name: subject.name, - value: subject, - validation: this.validateOption(subject, this.child) - }) - } - - return options - } - - get child_options() { - /* Return the child options for this subject relation */ - - const options = [] - for (const subject of this.graph.subjects) { - - // Check if the subject has a name - if (!this.hasName(subject)) continue - - // Add the subject to options - options.push({ - name: subject.name, - value: subject, - validation: this.validateOption(this.parent, subject) - }) - } - - return options - } - - static create(graph: Graph): SubjectRelation { - /* Create a new subject relation */ - - const relation = new SubjectRelation(graph, uuid.v4(), graph.subject_relations.length) - graph.subject_relations.push(relation) - return relation - } - - private isInconsistent(parent?: Subject, child?: Subject): boolean { - /* Check if the relation is consistent */ - - if (!this.isDefined(parent?.domain, child?.domain) || parent!.domain === child!.domain) - return false - return parent!.domain!.children.every(domain_child => domain_child !== child!.domain) - } - - private isDuplicate(parent?: Subject, child?: Subject): boolean { - /* Check if the relation is a duplicate */ - - return -1 !== this.graph.subject_relations.findIndex(relation => - relation !== this && - relation.parent === parent && - relation.child === child - ) - } - - private validateOption(parent?: Subject, child?: Subject): ValidationData { - const validation = new ValidationData() - - // Check if the relation is defined - if (!this.isDefined(parent, child)) - return validation - - // Check if the relation is self-referential - if (this.isSelfReferential(parent, child)) - validation.add({ severity: Severity.error, short: 'Self-referential' }) - - // Check if the relation is a duplicate - else if (this.isDuplicate(parent, child)) - validation.add({ severity: Severity.error, short: 'Duplicate relation' }) - - // Check if the relation is cyclic - else if (this.isCyclic(parent, child)) - validation.add({ severity: Severity.error, short: 'Cyclic relation' }) - - // Check if the relation is consistent - else if (this.isInconsistent(parent, child)) - validation.add({ severity: Severity.warning, short: 'Inconsistent' }) - - return validation - } - - validate(): ValidationData { - /* Validate this subject relation */ - - const response = new ValidationData() - - // Check if the relation is defined - if (!this.isDefined(this.parent, this.child)) { - response.add({ - severity: Severity.error, - short: 'Subject relation is not fully defined', - long: 'Both the parent and child subjects must be selected', - tab: 2, - anchor: this.anchor - }) - } - - // Check if the relation is consistent - if (this.isInconsistent(this.parent, this.child)) { - response.add({ - severity: Severity.warning, - short: 'Subject relation is inconsistent', - long: 'The domains of these subjects are not related', - tab: 2, - anchor: this.anchor - }) - } - - return response - } - - delete(): void { - /* Delete this subject relation */ - - // Shift indexes - for (const relation of this.graph.subject_relations) { - if (relation.index > this.index) { - relation.index-- - } - } - - // Remove references in the parent and child - if (this.isDefined(this.parent, this.child)) { - this.parent!.children = this.parent!.children.filter(child => child !== this.child) - this.child!.parents = this.child!.parents.filter(parent => parent !== this.parent) - } - - // Remove this relation from the graph - this.graph.subject_relations = this.graph.subject_relations.filter(relation => relation !== this) - } -} diff --git a/src/lib/scripts/entities/index.ts b/src/lib/scripts/entities/index.ts deleted file mode 100644 index 3c17733..0000000 --- a/src/lib/scripts/entities/index.ts +++ /dev/null @@ -1,14 +0,0 @@ - -export { ValidationData, Severity } from './Validation' -export { BaseModal } from './BaseModal' -export { Graph, SortOption } from './Graph' -export { Course, AssignedUser, Permissions } from './Course' -export { Field, Domain, Subject } from './Fields' -export { Relation, DomainRelation, SubjectRelation } from './Relations' -export { Lecture, LectureSubject } from './Lecture' - -export type { SerializedCourse, SerializedAssignedUser } from './Course' -export type { SerializedGraph, SortOptions } from './Graph' -export type { SerializedDomain, SerializedSubject } from './Fields' -export type { SerializedLecture } from './Lecture' -export type { Violation } from './Validation' diff --git a/src/lib/scripts/helpers/CourseHelper.ts b/src/lib/scripts/helpers/CourseHelper.ts new file mode 100644 index 0000000..ee9560f --- /dev/null +++ b/src/lib/scripts/helpers/CourseHelper.ts @@ -0,0 +1,335 @@ + +// External dependencies +import prisma from '$lib/server/prisma' +import type { Course as PrismaCourse } from '@prisma/client' + +// Internal dependencies +import { array_delta } from './delta' + +import { + GraphHelper, + LinkHelper, + UserHelper, + ProgramHelper +} from '$scripts/helpers' + +import type { + SerializedCourse, + SerializedGraph, + SerializedLink, + SerializedUser, + SerializedProgram +} from '$scripts/types' + +// Exports +export { + create, // api/course POST + update, // api/course PUT + remove, // api/course/[id] DELETE + reduce, + getAll, // api/course GET + getById, // api/course/[id] GET + getGraphs, // api/course/[id]/graphs GET + getLinks, // api/course/[id]/links GET + getAdmins, // api/course/[id]/admins GET + getEditors, // api/course/[id]/editors GET + getPrograms // api/course/[id]/programs GET +} + + +// --------------------> Helper Functions + + +/** + * Creates a Course object in the database + * @param code Course code + * @param name Course name + * @returns Newly created serialized Course + */ + +async function create(code: string, name: string): Promise { + try { + var course = await prisma.course.create({ + data: { + code, + name + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(course) +} + +/** + * Updates a Course in the database + * @param data Course data + */ + +async function update(data: SerializedCourse): Promise { + + // Get current data + const [graphs, programs, links] = await Promise.all([ + getGraphs(data.id), + getPrograms(data.id), + getLinks(data.id) + ]) + + // Get data delta + const graph_delta = array_delta(graphs, data.graphs) + const program_delta = array_delta(programs, data.programs) + const link_delta = array_delta(links, data.links) + + // Update + try { + await prisma.course.update({ + where: { + id: data.id + }, + data: { + name: data.name, + code: data.code, + graphs: graph_delta, + programs: program_delta, + links: link_delta + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Removes a Course from the database + * @param course_id Target Course ID + */ + +async function remove(course_id: number): Promise { + try { + await prisma.course.delete({ + where: { + id: course_id + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Reduces a Graph to a SerializedGraph + * @param graph Graph object + * @returns Serialized Graph + */ + +async function reduce(course: PrismaCourse): Promise { + + // Get additional data + try { + var data = await prisma.course.findUniqueOrThrow({ + where: { + id: course.id + }, + include: { + graphs: { + select: { + id: true + } + }, + links: { + select: { + id: true + } + }, + programs: { + select: { + id: true + } + }, + users: { + select: { + userId: true, + role: true + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + // Parse data + const graphs = data.graphs.map(graph => graph.id) + const links = data.links.map(link => link.id) + const programs = data.programs.map(program => program.id) + + const admins = data.users + .filter(user => user.role === 'ADMIN') + .map(user => Number(user.userId)) + + const editors = data.users + .filter(user => user.role === 'EDITOR') + .map(user => Number(user.userId)) + + // Return reduced data + return { + id: data.id, + code: data.code, + name: data.name, + graphs, links, admins, editors, programs + } +} + +/** + * Retrieves all Courses from the database + * @returns All serialized Courses + */ + +async function getAll(): Promise { + try { + var data = await prisma.course.findMany() + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(reduce)) +} + +/** + * Retrieves Courses by ID + * @param course_id Target Course ID + * @returns Serialized Course + */ + +async function getById(course_id: number): Promise { + try { + var data = await prisma.course.findUniqueOrThrow({ + where: { + id: course_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(data) +} + +/** + * Retrieves Graphs assigned to target Course + * @param course_id Target Course ID + * @returns Serialized Graphs + */ + +async function getGraphs(course_id: number): Promise { + try { + var data = await prisma.graph.findMany({ + where: { + course: { + id: course_id + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all( + data.map(GraphHelper.reduce) + ) +} + +/** + * Retrieves Links assigned to target Course + * @param course_id Target Course ID + * @returns Serialized Links + */ + +async function getLinks(course_id: number): Promise { + try { + var data = await prisma.graphLink.findMany({ + where: { + courseId: course_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(LinkHelper.reduce)) +} + +/** + * Retrieves Admins assigned to target Course + * @param course_id Target Course ID + * @returns Serialized Admins + */ + +async function getAdmins(course_id: number): Promise { + try { + var data = await prisma.user.findMany({ + where: { + courses: { + some: { + courseId: course_id, + role: 'ADMIN' + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(UserHelper.reduce)) +} + +/** + * Retrieves Editors assigned to target Course + * @param course_id Target Course ID + * @returns Serialized Editors + */ + +async function getEditors(course_id: number): Promise { + try { + var data = await prisma.user.findMany({ + where: { + courses: { + some: { + courseId: course_id, + role: 'EDITOR' + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(UserHelper.reduce)) +} + +/** + * Retrieves Programs assigned to target Course + * @param course_id Target Course ID + * @returns Serialized Programs + */ + +async function getPrograms(course_id: number): Promise { + try { + var data = await prisma.program.findMany({ + where: { + courses: { + some: { + id: course_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(ProgramHelper.reduce)) +} \ No newline at end of file diff --git a/src/lib/scripts/helpers/DomainHelper.ts b/src/lib/scripts/helpers/DomainHelper.ts new file mode 100644 index 0000000..8c0a4a1 --- /dev/null +++ b/src/lib/scripts/helpers/DomainHelper.ts @@ -0,0 +1,304 @@ + +// External dependencies +import prisma from '$lib/server/prisma' +import type { Domain as PrismaDomain } from '@prisma/client' + +// Internal dependencies +import { array_delta, required_field_delta } from './delta' + +import { + GraphHelper, + SubjectHelper + } from '$scripts/helpers' + +import type { + SerializedGraph, + SerializedDomain, + SerializedSubject +} from '$scripts/types' + +// Exports +export { + create, // api/domain POST + remove, // api/domain/[id] DELETE + update, // api/domain PUT + reduce, + getAll, // api/domain GET + getById, // api/domain/[id] GET + getGraph, // api/domain/[id]/graph GET + getParents, // api/domain/[id]/parents GET + getChildren, // api/domain/[id]/children GET + getSubjects // api/domain/[id]/subjects GET +} + + +// --------------------> Helper Functions + + +/** + * Creates a Domain object in the database + * @param graph_id ID of the Graph to which the Domain belongs + * @returns Serialized Domain + */ + +async function create(graph_id: number): Promise { + try { + var domain = await prisma.domain.create({ + data: { + graph: { + connect: { + id: graph_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(domain) +} + +/** + * Updates a Domain in the database + * @param data Serialized Domain + */ + +async function update(data: SerializedDomain): Promise { + + // Get current data + const [graph, parents, children] = await Promise.all([ + getGraph(data.id), + getParents(data.id), + getChildren(data.id) + ]) + + // Get data delta + const graph_delta = required_field_delta(graph, data.graph) + const parent_delta = array_delta(parents, data.parents) + const child_delta = array_delta(children, data.children) + + // Update domain + try { + await prisma.domain.update({ + where: { + id: data.id + }, + data: { + x: data.x, + y: data.y, + name: data.name, + style: data.style, + graph: graph_delta, + parentDomains: parent_delta, + childDomains: child_delta + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Removes a Domain from the database + * @param domain_id ID of the Domain to remove + */ + +async function remove(domain_id: number): Promise { + try { + await prisma.domain.delete({ + where: { + id: domain_id + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Reduces a Domain to a SerializedDomain + * @param domain Prisma Domain + * @returns Serialized Domain + */ + +async function reduce(domain: PrismaDomain): Promise { + + // Get aditional data + try { + var data = await prisma.domain.findUniqueOrThrow({ + where: { + id: domain.id + }, + include: { + parentDomains: { + select: { + id: true + } + }, + childDomains: { + select: { + id: true + } + } + } + }) + + var subject_data = await prisma.subject.findMany({ + where: { + domainId: domain.id + }, + select: { + id: true + } + }) + + } catch (error) { + return Promise.reject(error) + } + + // Parse data + const parents = data.parentDomains + .map(domain => domain.id) + const children = data.childDomains + .map(domain => domain.id) + const subjects = subject_data + .map(subject => subject.id) + + // Return reduced data + return { + graph: domain.graphId, + id: data.id, + x: data.x, + y: data.y, + name: data.name, + style: data.style, + parents, + children, + subjects + } +} + +/** + * Retrieves all Domains from the database + * @returns Array of serialized Domains + */ + +async function getAll(): Promise { + try { + var domains = await prisma.domain.findMany() + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(domains.map(reduce)) +} + +/** + * Retrieves a Domain by ID + * @param domain_id ID of the Domain to retrieve + * @returns Serialized Domain + */ + +async function getById(domain_id: number): Promise { + try { + var domain = await prisma.domain.findUniqueOrThrow({ + where: { + id: domain_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(domain) +} + +/** + * Get Graph this Domain belongs to + * @param domain_id ID of the Domain + * @returns Serialized Graph + */ + +async function getGraph(domain_id: number): Promise { + try { + var graph = await prisma.domain.findUniqueOrThrow({ + where: { + id: domain_id + }, + select: { + graph: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await GraphHelper.reduce(graph.graph) +} + +/** + * Get all parents of a Domain + * @param domain_id ID of the Domain + * @returns Array of serialized Domains + */ + +async function getParents(domain_id: number): Promise { + try { + var parents = await prisma.domain.findUniqueOrThrow({ + where: { + id: domain_id + }, + select: { + parentDomains: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(parents.parentDomains.map(reduce)) +} + +/** + * Get all children of a Domain + * @param domain_id ID of the Domain + * @returns Array of serialized Domains + */ + +async function getChildren(domain_id: number): Promise { + try { + var children = await prisma.domain.findUniqueOrThrow({ + where: { + id: domain_id + }, + select: { + childDomains: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(children.childDomains.map(reduce)) +} + +/** + * Get all subjects of a Domain + * @param domain_id ID of the Domain + * @returns Array of serialized Subjects + */ + +async function getSubjects(domain_id: number): Promise { + try { + var subjects = await prisma.subject.findMany({ + where: { + domainId: domain_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(subjects.map(SubjectHelper.reduce)) +} \ No newline at end of file diff --git a/src/lib/scripts/helpers/GraphHelper.ts b/src/lib/scripts/helpers/GraphHelper.ts new file mode 100644 index 0000000..6a7d9a3 --- /dev/null +++ b/src/lib/scripts/helpers/GraphHelper.ts @@ -0,0 +1,329 @@ + +// External dependencies +import prisma from '$lib/server/prisma' +import type { Graph as PrismaGraph } from '@prisma/client' + +// Internal dependencies +import { array_delta, required_field_delta } from './delta' + +import { + CourseHelper, + DomainHelper, + SubjectHelper, + LectureHelper, + LinkHelper +} from '$scripts/helpers' + +import type { + SerializedGraph, + SerializedCourse, + SerializedDomain, + SerializedSubject, + SerializedLecture, + SerializedLink +} from '$scripts/types' + +// Exports +export { + create, // api/graph POST + update, // api/graph PUT + remove, // api/graph/[id] DELETE + reduce, + getAll, // api/graph GET + getById, // api/graph/[id] GET + getCourse, // api/graph/[id]/course GET + getDomains, // api/graph/[id]/domains GET + getSubjects, // api/graph/[id]/subjects GET + getLectures, // api/graph/[id]/lectures GET + getLinks // api/graph/[id]/links GET +} + + +// --------------------> Helper Functions + + +/** + * Creates a Graph in the database + * @param course_id Course ID graph belongs to + * @param name Graph name + * @returns Serialized new Graph + */ + +async function create(course_id: number, name: string): Promise { + try { + var graph = await prisma.graph.create({ + data: { + name, + course: { + connect: { + id: course_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(graph) +} + +/** + * Updates a Graph in the database + * @param data New Graph data + */ + +async function update(data: SerializedGraph): Promise { + + // Get current data + const [course, domains, subjects, lectures, links] = await Promise.all([ + getCourse(data.id), + getDomains(data.id), + getSubjects(data.id), + getLectures(data.id), + getLinks(data.id) + ]) + + // Get data delta + const course_delta = required_field_delta(course, data.course) + const domain_delta = array_delta(domains, data.domains) + const subject_delta = array_delta(subjects, data.subjects) + const lecture_delta = array_delta(lectures, data.lectures) + const link_delta = array_delta(links, data.links) + + // Update + try { + await prisma.graph.update({ + where: { + id: data.id, + }, + data: { + name: data.name, + course: course_delta, + domains: domain_delta, + subjects: subject_delta, + lectures: lecture_delta, + links: link_delta + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Removes a Graph from the database + * @param graph_id Target Graph ID + */ + +async function remove(graph_id: number): Promise { + try { + console.log('graph_id', graph_id) + await prisma.graph.delete({ + where: { + id: graph_id + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Reduces a Graph to a SerializedGraph + * @param graph Graph object + * @returns Serialized Graph + */ + +async function reduce(graph: PrismaGraph): Promise { + + // Get aditional data + try { + var data = await prisma.graph.findUniqueOrThrow({ + where: { + id: graph.id + }, + include: { + domains: { + select: { + id: true + } + }, + subjects: { + select: { + id: true + } + }, + lectures: { + select: { + id: true + } + }, + links: { + select: { + id: true + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + // Parse data + const domains = data.domains + .map(domain => domain.id) + const subjects = data.subjects + .map(subject => subject.id) + const lectures = data.lectures + .map(lecture => lecture.id) + const links = data.links + .map(link => link.id) + + // Return reduced data + return { + id: data.id, + name: data.name, + course: data.courseId, + domains, subjects, lectures, links + } +} + +/** + * Retrieves all Graphs from the database + * @returns Array of Serialized Graphs + */ + +async function getAll(): Promise { + try { + var graphs = await prisma.graph.findMany() + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(graphs.map(reduce)) +} + +/** + * Retrieves Graphs by ID + * @param group_id Target Graph ID + * @returns Serialized Graph + */ + +async function getById(graph_id: number): Promise { + try { + var graph = await prisma.graph.findUniqueOrThrow({ + where: { + id: graph_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(graph) +} + +/** + * Retrieves Course assigned to target Graph + * @param graph_id Target Graph ID + * @returns Serialized Course + */ + +async function getCourse(graph_id: number): Promise { + try { + var data = await prisma.course.findFirstOrThrow({ + where: { + graphs: { + some: { + id: graph_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await CourseHelper.reduce(data) +} + +/** + * Retrieves Domains assigned to target Graph + * @param graph_id Target Graph ID + * @returns Serialized Graphs + */ + +async function getDomains(graph_id: number): Promise { + try { + var data = await prisma.domain.findMany({ + where: { + graphId: graph_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(DomainHelper.reduce)) +} + +/** + * Retrieves Subjects assigned to target Graph. + * @param graph_id Target Graph ID + * @returns Serialized Subjects + */ + +async function getSubjects(graph_id: number): Promise { + try { + var subjects = await prisma.subject.findMany({ + where: { + graphId: graph_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(subjects.map(SubjectHelper.reduce)) +} + +/** + * Retrieves Lectures assigned to target Graph + * @param graph_id Target Graph ID + * @returns Serialized Lectures + */ + +async function getLectures(graph_id: number): Promise { + try { + var lectures = await prisma.lecture.findMany({ + where: { + graphId: graph_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(lectures.map(LectureHelper.reduce)) +} + +/** + * Retrieves Links assigned to target Graph + * @param graph_id Target Graph ID + * @returns Serialized Links + */ + +async function getLinks(graph_id: number): Promise { + try { + var data = await prisma.graphLink.findMany({ + where: { + graphId: graph_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(LinkHelper.reduce)) +} \ No newline at end of file diff --git a/src/lib/scripts/helpers/LectureHelper.ts b/src/lib/scripts/helpers/LectureHelper.ts new file mode 100644 index 0000000..0fca91d --- /dev/null +++ b/src/lib/scripts/helpers/LectureHelper.ts @@ -0,0 +1,207 @@ + +// External dependencies +import prisma from '$lib/server/prisma' +import type { Lecture as PrismaLecture } from '@prisma/client' + +// Internal dependencies +import { array_delta, required_field_delta } from './delta' + +import { + GraphHelper, + SubjectHelper +} from '$scripts/helpers' + +import type { + SerializedLecture, + SerializedGraph, + SerializedSubject +} from '$scripts/types' + +// Exports +export { + create, // api/lecture POST + remove, // api/lecture/[id] DELETE + update, // api/lecture PUT + reduce, + getAll, // api/lecture GET + getById, // api/lecture/[id] GET + getGraph, // api/lecture/[id]/graph GET + getSubjects // api/lecture/[id]/subjects GET +} + + +// --------------------> Helper Functions + + +/** + * Creates a Lecture object in the database + * @param graph_id ID of the Graph to which the Lecture belongs + * @returns SerializedLecture object + */ + +async function create(graph_id: number): Promise { + try { + var lecture = await prisma.lecture.create({ + data: { + graph: { + connect: { + id: graph_id + } + } + } + }) + } catch (error) { + return Promise.reject('Failed to create lecture') + } + + return await reduce(lecture) +} + +/** + * Removes a Lecture from the database. + * @param lecture_id ID of the Lecture to remove + */ + +async function remove(lecture_id: number): Promise { + try { + await prisma.lecture.delete({ + where: { + id: lecture_id + } + }) + } catch (error) { + return Promise.reject('Failed to remove subject') + } +} + +/** + * Updates a Lecture in the database. + * @param data SerializedLecture object + */ + +async function update(data: SerializedLecture): Promise { + + // Get current data + const [graph, subjects] = await Promise.all([ + getGraph(data.id), + getSubjects(data.id) + ]) + + // Get data delta + const graph_delta = required_field_delta(graph, data.graph) + const subject_delta = array_delta(subjects, data.subjects) + + // Update lecture + try { + await prisma.lecture.update({ + where: { + id: data.id + }, + data: { + name: data.name, + graph: graph_delta, + subjects: subject_delta + } + }) + } catch (error) { + return Promise.reject('Failed to update lecture') + } +} + +/** + * Reduces a PrismaLecture to a SerializedLecture + * @param lecture PrismaLecture object + * @returns SerializedLecture object + */ + +async function reduce(lecture: PrismaLecture): Promise { + const subjects = await getSubjects(lecture.id) + .catch(error => Promise.reject(error)) + + return { + id: lecture.id, + name: lecture.name, + subjects: subjects.map(subject => subject.id) + } +} + +/** + * Gets all Lectures in the database + * @returns Array of SerializedLecture objects + */ + +async function getAll(): Promise { + try { + var lectures = await prisma.lecture.findMany() + } catch (error) { + return Promise.reject(error) + } + + return Promise.all(lectures.map(reduce)) +} + +/** + * Gets a Lecture by ID + * @param lecture_id ID of the Lecture + * @returns SerializedLecture object + */ + +async function getById(lecture_id: number): Promise { + try { + var lecture = await prisma.lecture.findUniqueOrThrow({ + where: { + id: lecture_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(lecture) +} + +/** + * Gets the Graph of a Lecture + * @param lecture_id ID of the Lecture + * @returns SerializedGraph object + */ + +async function getGraph(lecture_id: number): Promise { + try { + var lecture = await prisma.lecture.findUniqueOrThrow({ + where: { + id: lecture_id + }, + select: { + graph: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await GraphHelper.reduce(lecture.graph) +} + +/** + * Gets the Subjects of a Lecture + * @param lecture_id ID of the Lecture + * @returns Array of SerializedSubject objects + */ + +async function getSubjects(lecture_id: number): Promise { + try { + var lecture = await prisma.lecture.findUniqueOrThrow({ + where: { + id: lecture_id + }, + select: { + subjects: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(lecture.subjects.map(SubjectHelper.reduce)) +} diff --git a/src/lib/scripts/helpers/LinkHelper.ts b/src/lib/scripts/helpers/LinkHelper.ts new file mode 100644 index 0000000..0a7cab0 --- /dev/null +++ b/src/lib/scripts/helpers/LinkHelper.ts @@ -0,0 +1,218 @@ + +// External dependencies +import prisma from '$lib/server/prisma' +import type { GraphLink as PrismaLink } from '@prisma/client' + +// Internal dependencies +import { required_field_delta, optional_field_delta } from './delta' + +import { + CourseHelper, + GraphHelper +} from '$scripts/helpers' + +import type { + SerializedLink, + SerializedCourse, + SerializedGraph +} from '$scripts/types' + +// Exports +export { + create, // api/link POST + update, // api/link PUT + remove, // api/link/[id] DELETE + reduce, + getAll, // api/link GET + getById, // api/link/[id] GET + getCourse, // api/link/[id]/course GET + getGraph // api/link/[id]/graph GET +} + + +// --------------------> Helper Functions + + +/** + * Creates a Link in the database + * @param course_id Course ID link belongs to + * @param graph_id Graph ID belonging to link + * @param name Link name + * @returns Serialized new Link + */ + +async function create(course_id: number, graph_id: number | null, name: string): Promise { + + // Get graph data + const graph_data = graph_id ? { id: graph_id } : undefined + + try { + var link = await prisma.graphLink.create({ + data: { + name, + course: { + connect: { + id: course_id + } + }, + graph: { + connect: graph_data + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(link) +} + +/** + * Updates a Link in the database + * @param data New Link data + */ + +async function update(data: SerializedLink): Promise { + + // Get current data + const [course, graph] = await Promise.all([ + getCourse(data.id), + getGraph(data.id) + ]) + + // Get data deltas + const course_delta = required_field_delta(course, data.course) + const graph_delta = optional_field_delta(graph, data.graph) + + // Update + try { + await prisma.graphLink.update({ + where: { + id: data.id + }, + data: { + name: data.name, + course: course_delta, + graph: graph_delta + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Removes a Link from the database + * @param link_id Target Link ID + */ + +async function remove(link_id: number): Promise { + try { + await prisma.graphLink.delete({ + where: { + id: link_id + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Reduces a Link to a SerializedLink + * @param link Link object + * @returns Serialized Link + */ + +async function reduce(link: PrismaLink): Promise { + return { + id: link.id, + name: link.name, + graph: link.graphId, + course: link.courseId + } +} + +/** + * Gets all Links from the database + * @returns Array of Serialized Links + */ + +async function getAll(): Promise { + try { + var links = await prisma.graphLink.findMany() + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(links.map(reduce)) +} + +/** + * Gets a Link by ID from the database + * @param link_id Target Link ID + * @returns Serialized Link + */ + +async function getById(link_id: number): Promise { + try { + var link = await prisma.graphLink.findUniqueOrThrow({ + where: { + id: link_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(link) +} + +/** + * Gets the Course assigned to a Link. + * @param link_id Target Link ID + * @returns Serialized Course + */ + +async function getCourse(link_id: number): Promise { + try { + var data = await prisma.course.findFirstOrThrow({ + where: { + links: { + some: { + id: link_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await CourseHelper.reduce(data) +} + +/** + * Gets the Graph assigned to a Link + * @param link_id Target Link ID + * @returns Serialized Graph + */ + +async function getGraph(link_id: number): Promise { + try { + var data = await prisma.graphLink.findUniqueOrThrow({ + where: { + id: link_id + }, + select: { + graph: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + if (data.graph) + return await GraphHelper.reduce(data.graph) + return null +} \ No newline at end of file diff --git a/src/lib/scripts/helpers/ProgramHelper.ts b/src/lib/scripts/helpers/ProgramHelper.ts new file mode 100644 index 0000000..4441cec --- /dev/null +++ b/src/lib/scripts/helpers/ProgramHelper.ts @@ -0,0 +1,261 @@ + +// External dependencies +import prisma from '$lib/server/prisma' +import type { Program as PrismaProgram } from '@prisma/client' + +// Internal dependencies +import { array_delta } from './delta' + +import { + CourseHelper, + UserHelper +} from '$scripts/helpers' + +import type { + SerializedProgram, + SerializedCourse, + SerializedUser +} from '$scripts/types' + +// Exports +export { + create, // api/program + remove, // api/program/[id] + update, // api/program + reduce, + getAll, // api/program + getById, // api/program/[id] + getCourses, // api/program/[id]/courses + getAdmins, // api/program/[id]/admins + getEditors // api/program/[id]/editors +} + + +// --------------------> Helper Functions + + +/** + * Creates a new Program in the database + * @param name Program name + * @returns Newly created Serialized Program + */ + +async function create(name: string): Promise { + try { + var program = await prisma.program.create({ + data: { + name + }} + ) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(program) +} + +/** + * Removes Program from the database + * @param program_id Target Program ID + */ + +async function remove(program_id: number): Promise { + try { + await prisma.program.delete({ + where: { + id: program_id + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Updates a Program in the database + * @param data Serialized Program data + */ + +async function update(data: SerializedProgram): Promise { + + // Get current data + const courses = await getCourses(data.id) + + // Get data delta + const course_delta = array_delta(courses, data.courses) + + // Update + try { + await prisma.program.update({ + where: { + id: data.id + }, + data: { + name: data.name, + courses: course_delta + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Reduces a Program to a SerializedProgram + * @param program Program object + * @returns Serialized Program + */ + +async function reduce(program: PrismaProgram): Promise { + + // Get additional data + try { + var data = await prisma.program.findUniqueOrThrow({ + where: { + id: program.id + }, + include: { + courses: { + select: { + id: true + } + }, + users: { + select: { + userId: true, + role: true + } + }, + } + }) + } catch (error) { + return Promise.reject(error) + } + + // Parse data + const courses = data.courses.map(course => course.id) + + const admins = data.users + .filter(user => user.role === 'ADMIN') + .map(user => Number(user.userId)) + + const editors = data.users + .filter(user => user.role === 'EDITOR') + .map(user => Number(user.userId)) + + // Return reduced data + return { + id: data.id, + name: data.name, + courses, admins, editors + } +} + +/** + * Retrieves all Programs from the database + * @returns Array of Serialized Programs + */ + +async function getAll(): Promise { + try { + var courses = await prisma.program.findMany() + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(courses.map(reduce)) +} + +/** + * Retrieves program by ID + * @param program_id Target Program ID + * @returns Serialized Program + */ + +async function getById(program_id: number): Promise { + try { + var program = await prisma.program.findUniqueOrThrow({ + where: { + id: program_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(program) +} + +/** + * Retrieves Program courses + * @param program_id Target Program ID + * @returns Array of Serialized Courses + */ + +async function getCourses(program_id: number): Promise { + try { + var data = await prisma.course.findMany({ + where: { + programs: { + some: { + id: program_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(CourseHelper.reduce)) +} + +/** + * Retrieves Program admin Users + * @param program_id Target Program ID + * @returns Array of Serialized Users + */ + +async function getAdmins(program_id: number): Promise { + try { + var data = await prisma.user.findMany({ + where: { + programs: { + some: { + programId: program_id, + role: 'ADMIN' + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(UserHelper.reduce)) +} + +/** + * Retrieves Program editor Users + * @param program_id Target Program ID + * @returns Array of Serialized Users + */ + +async function getEditors(program_id: number): Promise { + try { + var data = await prisma.user.findMany({ + where: { + programs: { + some: { + programId: program_id, + role: 'EDITOR' + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(data.map(UserHelper.reduce)) +} \ No newline at end of file diff --git a/src/lib/scripts/helpers/SubjectHelper.ts b/src/lib/scripts/helpers/SubjectHelper.ts new file mode 100644 index 0000000..7ec70ea --- /dev/null +++ b/src/lib/scripts/helpers/SubjectHelper.ts @@ -0,0 +1,299 @@ + +// External dependencies +import prisma from '$lib/server/prisma' +import type { Subject as PrismaSubject } from '@prisma/client' + +// Internal dependencies +import { array_delta, required_field_delta, optional_field_delta } from './delta' + +import { + GraphHelper, + DomainHelper, + LectureHelper +} from '$scripts/helpers' + +import type { + SerializedGraph, + SerializedDomain, + SerializedSubject, + SerializedLecture +} from '$scripts/types' + +// Exports +export { + create, // api/subject POST + remove, // api/subject/[id] DELETE + update, // api/subject PUT + reduce, + getAll, // api/subject GET + getById, // api/subject/[id] GET + getGraph, // api/subject/[id]/graph GET + getDomain, // api/subject/[id]/domain GET + getParents, // api/subject/[id]/parents GET + getChildren, // api/subject/[id]/children GET + getLectures, // api/subject/[id]/lectures GET +} + + +// --------------------> Helper Functions + +/** + * Creates a Subject object in the database + * @param graph_id ID of the Graph to which the Subject belongs + * @returns SerializedSubject object + */ + +async function create(graph_id: number): Promise { + try { + var subject = await prisma.subject.create({ + data: { + graph: { + connect: { + id: graph_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(subject) +} + +/** + * Removes a Subject from the database + * @param subject_id ID of the Subject to remove + */ + +async function remove(subject_id: number): Promise { + try { + await prisma.subject.delete({ + where: { + id: subject_id + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Updates a Subject in the database + * @param data SerializedSubject object + */ + +async function update(data: SerializedSubject): Promise { + + // Get current data + const [graph, domain, parents, children, lectures] = await Promise.all([ + getGraph(data.id), + getDomain(data.id), + getParents(data.id), + getChildren(data.id), + getLectures(data.id) + ]) + + // Get data deltas + const graph_delta = required_field_delta(graph, data.graph) + const domain_delta = optional_field_delta(domain, data.domain) + const parent_delta = array_delta(parents, data.parents) + const child_delta = array_delta(children, data.children) + const lecture_delta = array_delta(lectures, data.lectures) + + // Update subject + try { + await prisma.subject.update({ + where: { + id: data.id + }, + data: { + x: data.x, + y: data.y, + name: data.name, + graph: graph_delta, + domain: domain_delta, + parentSubjects: parent_delta, + childSubjects: child_delta, + lectures: lecture_delta + } + }) + } catch (error) { + return Promise.reject(error) + } +} + +/** + * Reduces a PrismaSubject to a SerializedSubject + * @param subject PrismaSubject object + * @returns SerializedSubject object + */ + +async function reduce(subject: PrismaSubject): Promise { + const [children, parents] = await Promise.all([ + getChildren(subject.id), + getParents(subject.id) + ]) + + return { + id: subject.id, + x: subject.x, + y: subject.y, + name: subject.name, + domain: subject.domainId, + children: children.map(subject => subject.id), + parents: parents.map(subject => subject.id) + } +} + +/** + * Retrieves all Subjects from the database + * @returns Array of SerializedSubject objects + */ + +async function getAll(): Promise { + try { + var subjects = await prisma.subject.findMany() + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(subjects.map(reduce)) +} + +/** + * Retrieves a Subject by ID from the database + * @param subject_id ID of the Subject to retrieve + * @returns SerializedSubject object + */ + +async function getById(subject_id: number): Promise { + try { + var subject = await prisma.subject.findUniqueOrThrow({ + where: { + id: subject_id + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await reduce(subject) +} + +/** + * Retrieves the Graph to which a Subject belongs + * @param subject_id ID of the Subject + * @returns SerializedGraph object + */ + +async function getGraph(subject_id: number): Promise { + try { + var graph = await prisma.subject.findUniqueOrThrow({ + where: { + id: subject_id + }, + select: { + graph: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await GraphHelper.reduce(graph.graph) +} + +/** + * Retrieves the Domain to which a Subject belongs + * @param subject_id ID of the Subject + * @returns SerializedDomain object + */ + +async function getDomain(subject_id: number): Promise { + try { + var domain = await prisma.subject.findUniqueOrThrow({ + where: { + id: subject_id + }, + select: { + domain: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + if (!domain.domain) return null + return await DomainHelper.reduce(domain.domain) +} + +/** + * Retrieves all parent Subjects of a Subject + * @param subject_id ID of the Subject + * @returns Array of SerializedSubject objects + */ + +async function getParents(subject_id: number): Promise { + try { + var parents = await prisma.subject.findUniqueOrThrow({ + where: { + id: subject_id + }, + select: { + parentSubjects: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(parents.parentSubjects.map(reduce)) +} + +/** + * Retrieves all child Subjects of a Subject + * @param subject_id ID of the Subject + * @returns Array of SerializedSubject objects + */ + +async function getChildren(subject_id: number): Promise { + try { + var children = await prisma.subject.findUniqueOrThrow({ + where: { + id: subject_id + }, + select: { + childSubjects: true + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(children.childSubjects.map(reduce)) +} + +/** + * Retrieves all Lectures associated with a Subject + * @param subject_id ID of the Subject + * @returns Array of SerializedLecture objects + */ + +async function getLectures(subject_id: number): Promise { + try { + var lectures = await prisma.lecture.findMany({ + where: { + subjects: { + some: { + id: subject_id + } + } + } + }) + } catch (error) { + return Promise.reject(error) + } + + return await Promise.all(lectures.map(LectureHelper.reduce)) +} \ No newline at end of file diff --git a/src/lib/scripts/helpers/delta.ts b/src/lib/scripts/helpers/delta.ts new file mode 100644 index 0000000..864a3fd --- /dev/null +++ b/src/lib/scripts/helpers/delta.ts @@ -0,0 +1,67 @@ + +interface IWithID { + id: number +} + +export function array_delta(prev: (T | number)[], next: (T | number)[]): { connect?: { id: number }[], disconnect?: { id: number }[] } { + const prev_ids = prev.map(item => typeof item === 'number' ? { id: item } : { id: item.id }) + const next_ids = next.map(item => typeof item === 'number' ? { id: item } : { id: item.id }) + + // Easy cases + if (prev.length === 0 && next.length === 0) + return {} + if (prev.length === 0) + return { connect: next_ids } + if (next.length === 0) + return { disconnect: prev_ids } + + // Regular case + const connect = next_ids + .filter(next_item => !prev_ids.some(prev_item => prev_item.id === next_item.id)) + const disconnect = prev_ids + .filter(prev_item => !next_ids.some(next_item => next_item.id === prev_item.id)) + + const result: { connect?: { id: number }[], disconnect?: { id: number }[] } = {} + if (connect.length) + result.connect = connect + if (disconnect.length) + result.disconnect = disconnect + + return result +} + +export function required_field_delta(prev: T | number, next: T | number): {} | { connect: { id: number }, disconnect: { id: number } } { + const prev_id = typeof prev === 'number' ? prev : prev.id + const next_id = typeof next === 'number' ? next : next.id + + // Easy case + if (prev_id === next_id) { + return {} + } + + // Regular case + return { + connect: { id: next_id }, + disconnect: { id: prev_id } + } +} + +export function optional_field_delta(prev: T | number | null, next: T | number | null): { connect?: { id: number }, disconnect?: { id: number } } { + const prev_id = prev === null ? null : typeof prev === 'number' ? prev : prev.id + const next_id = next === null ? null : typeof next === 'number' ? next : next.id + + // Easy cases + if (prev_id === next_id) + return {} + if (prev_id === null && next_id !== null) + return { connect: { id: next_id } } + if (prev_id !== null && next_id === null) { + return { disconnect: { id: prev_id } } + } + + // Regular case + return { + connect: { id: next_id! }, + disconnect: { id: prev_id! } + } +} \ No newline at end of file diff --git a/src/lib/scripts/helpers/index.ts b/src/lib/scripts/helpers/index.ts new file mode 100644 index 0000000..f6ca7e8 --- /dev/null +++ b/src/lib/scripts/helpers/index.ts @@ -0,0 +1,8 @@ + +export * as ProgramHelper from './ProgramHelper' +export * as CourseHelper from './CourseHelper' +export * as DomainHelper from './DomainHelper' +export * as GraphHelper from './GraphHelper' +export * as LectureHelper from './LectureHelper' +export * as SubjectHelper from './SubjectHelper' +export * as LinkHelper from './LinkHelper' diff --git a/src/lib/scripts/hocusfocus.ts b/src/lib/scripts/hocusfocus.ts index 9d10923..d93ba2d 100644 --- a/src/lib/scripts/hocusfocus.ts +++ b/src/lib/scripts/hocusfocus.ts @@ -23,16 +23,44 @@ export function focusonhover(element: HTMLElement) { export function losefocus(element: HTMLElement, callback: () => void) { function checkFocus() { let had_focus = has_focus - has_focus = element.contains(document.activeElement) + has_focus = element.contains(document.activeElement) || + element === document.activeElement || + document.activeElement === document.body if (had_focus && !has_focus) callback() } let has_focus = element.contains(document.activeElement) document.addEventListener('focusin', checkFocus) + document.addEventListener('focusout', checkFocus) return { destroy() { document.removeEventListener('focusin', checkFocus) + document.removeEventListener('focusout', checkFocus) } - }; + } +} + +export function loopfocus(element: HTMLElement) { + const focusable = element.querySelectorAll('button, [href], input, select, textarea, [tabindex]:not([tabindex="-1"])') + if (!focusable.length) return {} + + let index = 0 + focusable[index].focus() + + function onKeyDown(event: KeyboardEvent) { + if (event.key === 'Tab') { + event.preventDefault() + index = (index + 1) % focusable.length + focusable[index].focus() + } + } + + element.addEventListener('keydown', onKeyDown) + + return { + destroy() { + element.removeEventListener('keydown', onKeyDown) + } + } } diff --git a/src/lib/scripts/entities/BaseModal.ts b/src/lib/scripts/modals.ts similarity index 70% rename from src/lib/scripts/entities/BaseModal.ts rename to src/lib/scripts/modals.ts index 2fafd42..73a0f2f 100644 --- a/src/lib/scripts/entities/BaseModal.ts +++ b/src/lib/scripts/modals.ts @@ -1,12 +1,18 @@ // Internal imports -import { ValidationData } from '$scripts/entities' +import { ValidationData } from '$scripts/validation' // External imports -import Modal from '$components/Modal.svelte' +import Modal from '$components/layouts/Modal.svelte' -// Base class for modals -export abstract class BaseModal { +// Exports +export { BaseModal } + + +// --------------------> Classes + + +abstract class BaseModal { private defaults: { [key: string]: any } = {} modal?: Modal @@ -32,4 +38,5 @@ export abstract class BaseModal { } abstract validate(): ValidationData + abstract submit(): void } \ No newline at end of file diff --git a/src/lib/scripts/settings.ts b/src/lib/scripts/settings.ts index 135c493..8c2df93 100644 --- a/src/lib/scripts/settings.ts +++ b/src/lib/scripts/settings.ts @@ -42,7 +42,7 @@ export const OVERLAY_FADE_OUT: Milliseconds = 500 export const OVERLAY_LINGER: Milliseconds = 1500 // Animation settings -export const FADE_DURATION: Milliseconds = 500 +export const FADE_DURATION: Milliseconds = 0 export const ANIMATION_DURATION: Milliseconds = 1000 export const SHAKE = { delay: 150, diff --git a/src/lib/scripts/types/DropdownOption.ts b/src/lib/scripts/types/DropdownOption.ts new file mode 100644 index 0000000..2e8a13c --- /dev/null +++ b/src/lib/scripts/types/DropdownOption.ts @@ -0,0 +1,3 @@ + +import type { ValidationData } from '$scripts/validation' +export type DropdownOption = { value: T, label: string, validation: ValidationData } \ No newline at end of file diff --git a/src/lib/scripts/types/Serialized.ts b/src/lib/scripts/types/Serialized.ts new file mode 100644 index 0000000..3492018 --- /dev/null +++ b/src/lib/scripts/types/Serialized.ts @@ -0,0 +1,143 @@ + +// Exports +export { + instanceOfSerializedUser, + instanceOfSerializedProgram, + instanceOfSerializedCourse, + instanceOfSerializedGraph, + instanceOfSerializedDomain, + instanceOfSerializedSubject, + instanceOfSerializedLecture, + instanceOfSerializedLink +} + +export type { + SerializedUser, + SerializedProgram, + SerializedCourse, + SerializedGraph, + SerializedDomain, + SerializedSubject, + SerializedLecture, + SerializedLink +} + + +// --------------------> Types + + +type SerializedUser = { + id: number, // Unique identifier + role: string, // User role + netid: string, // User netid + first_name: string, // User first name + last_name: string, // User last name + email: string, // User email + program_admin: number[], // List of Program IDs this User is an admin of + program_editor: number[], // List of Program IDs this User is an editor of + course_admin: number[], // List of Course IDs this User is an admin of + course_editor: number[] // List of Course IDs this User is an editor of +} + +type SerializedProgram = { + id: number, // Unique identifier + name: string, // Program name + courses: number[], // List of course IDs + admins: number[], // List of admin User IDs + editors: number[] // List of editor User IDs +} + +type SerializedCourse = { + id: number, // Unique identifier + code: string, // Course code + name: string, // Course name + graphs: number[], // List of graph IDs + links: number[], // List of link IDs + admins: number[], // List of admin User IDs + editors: number[], // List of editor User IDs + programs: number[] // List of program IDs this Course belongs to +} + +type SerializedGraph = { + id: number, // Unique identifier + name: string, // Graph name + course: number, // Course ID this Graph belongs to + domains: number[], // List of domain IDs + subjects: number[], // List of subject IDs + lectures: number[], // List of lecture IDs + links: number[] // List of link IDs +} + +type SerializedDomain = { + id: number, // Unique identifier + x: number, // X-coordinate of the Domain + y: number, // Y-coordinate of the Domain + name: string, // Domain name + style: string | null, // Domain style + graph: number, // Graph ID this Domain belongs to + parents: number[], // List of parent Domain IDs + children: number[] // List of child Domain IDs + subjects: number[] // List of subject IDs +} + +type SerializedSubject = { + id: number, // Unique identifier + x: number, // X-coordinate of the Subject + y: number, // Y-coordinate of the Subject + name: string, // Subject name + domain: number | null, // Domain ID this Subject belongs to + graph: number, // Graph ID this Subject belongs to + parents: number[], // List of parent Subject IDs + children: number[], // List of child Subject IDs + lectures: number[] // List of lecture IDs this Subject belongs to +} + +type SerializedLecture = { + id: number, // Unique identifier + name: string, // Lecture name + graph: number, // Graph ID this Lecture belongs to + subjects: number[] // List of subject IDs +} + +type SerializedLink = { + id: number, // Unique identifier + name: string, // Link name + course: number, // Course ID this Link belongs to + graph: number | null // Graph ID this Link belongs to +} + + +// --------------------> Instance Methods + + +function instanceOfSerializedUser(object: any): object is SerializedUser { + return 'id' in object && 'role' in object && 'netid' in object && 'first_name' in object && 'last_name' in object && 'email' in object && 'program_admin' in object && 'program_editor' in object && 'course_admin' in object && 'course_editor' in object +} + +function instanceOfSerializedProgram(object: any): object is SerializedProgram { + return 'id' in object && 'name' in object && 'courses' in object && 'admins' in object && 'editors' in object +} + +function instanceOfSerializedCourse(object: any): object is SerializedCourse { + return 'id' in object && 'code' in object && 'name' in object && 'graphs' in object && 'admins' in object && 'editors' in object && 'programs' in object +} + +function instanceOfSerializedGraph(object: any): object is SerializedGraph { + return 'id' in object && 'name' in object && 'course' in object && 'domains' in object && 'subjects' in object && 'lectures' in object +} + +function instanceOfSerializedDomain(object: any): object is SerializedDomain { + return 'id' in object && 'x' in object && 'y' in object && 'name' in object && 'style' in object && 'graph' in object && 'parents' in object && 'children' in object && 'subjects' in object +} + +function instanceOfSerializedSubject(object: any): object is SerializedSubject { + return 'id' in object && 'x' in object && 'y' in object && 'name' in object && 'domain' in object && 'graph' in object && 'parents' in object && 'children' in object && 'lectures' in object +} + +function instanceOfSerializedLecture(object: any): object is SerializedLecture { + return 'id' in object && 'name' in object && 'graph' in object && 'subjects' in object +} + +function instanceOfSerializedLink(object: any): object is SerializedLink { + return 'id' in object && 'name' in object && 'course' in object && 'graph' in object +} \ No newline at end of file diff --git a/src/lib/scripts/types/index.ts b/src/lib/scripts/types/index.ts new file mode 100644 index 0000000..bf773f5 --- /dev/null +++ b/src/lib/scripts/types/index.ts @@ -0,0 +1,26 @@ + +export type { + SerializedUser, + SerializedProgram, + SerializedCourse, + SerializedGraph, + SerializedDomain, + SerializedSubject, + SerializedLecture, + SerializedLink +} from './Serialized' + +export { + instanceOfSerializedUser, + instanceOfSerializedProgram, + instanceOfSerializedCourse, + instanceOfSerializedGraph, + instanceOfSerializedDomain, + instanceOfSerializedSubject, + instanceOfSerializedLecture, + instanceOfSerializedLink +} from './Serialized' + +export type { + DropdownOption, +} from './DropdownOption' diff --git a/src/lib/scripts/entities/Validation.ts b/src/lib/scripts/validation.ts similarity index 64% rename from src/lib/scripts/entities/Validation.ts rename to src/lib/scripts/validation.ts index 7dc31ea..b770785 100644 --- a/src/lib/scripts/entities/Validation.ts +++ b/src/lib/scripts/validation.ts @@ -18,7 +18,7 @@ type Violation = { short: string, long?: string, tab?: number, - anchor?: string + uuid?: string } class ValidationData { @@ -47,7 +47,37 @@ class ValidationData { } } + okay(): boolean { + return this.severity !== Severity.error + } + static success() { return new ValidationData() } + + static warning(short: string, long?: string, tab?: number, uuid?: string) { + const data = new ValidationData() + data.add({ + severity: Severity.warning, + short, + long, + tab, + uuid + }) + + return data + } + + static error(short: string, long?: string, tab?: number, uuid?: string) { + const data = new ValidationData() + data.add({ + severity: Severity.error, + short, + long, + tab, + uuid + }) + + return data + } } \ No newline at end of file diff --git a/src/lib/server/controllers/CourseController.ts b/src/lib/server/controllers/CourseController.ts deleted file mode 100644 index cf8a7b3..0000000 --- a/src/lib/server/controllers/CourseController.ts +++ /dev/null @@ -1,13 +0,0 @@ -import prisma from '$lib/server/prisma'; - -import { CourseHelper } from '$lib/server/helpers'; - - -export async function getCourseByCode(code: string) { - const course = await prisma.course.findUniqueOrThrow({ - where: { - code - } - }); - return await CourseHelper.toDTO(course) -} diff --git a/src/lib/server/controllers/DomainController.ts b/src/lib/server/controllers/DomainController.ts deleted file mode 100644 index ff8b4c5..0000000 --- a/src/lib/server/controllers/DomainController.ts +++ /dev/null @@ -1 +0,0 @@ -export default {}; diff --git a/src/lib/server/controllers/GraphController.ts b/src/lib/server/controllers/GraphController.ts deleted file mode 100644 index c29191e..0000000 --- a/src/lib/server/controllers/GraphController.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { error } from '@sveltejs/kit'; -import prisma from '$lib/server/prisma'; - -import { GraphHelper } from '$lib/server/helpers'; -import { type SerializedGraph } from '$scripts/entities'; - - -export async function getGraphsByCourseCode(code: string) { - const graphs = await prisma.graph.findMany({ - where: { - course: { - code - } - }, - orderBy: { - createdAt: 'asc' - } - }); - return await Promise.all(graphs.map(g => GraphHelper.toDTO(g))); -} - - -export async function getGraphById(id: number): Promise { - const graph = await prisma.graph.findUnique({ - where: { - id - } - }); - - if (!graph) error(404, 'Graph not found'); - - return await GraphHelper.toDTO(graph); -} diff --git a/src/lib/server/controllers/LectureController.ts b/src/lib/server/controllers/LectureController.ts deleted file mode 100644 index ff8b4c5..0000000 --- a/src/lib/server/controllers/LectureController.ts +++ /dev/null @@ -1 +0,0 @@ -export default {}; diff --git a/src/lib/server/controllers/SubjectController.ts b/src/lib/server/controllers/SubjectController.ts deleted file mode 100644 index ff8b4c5..0000000 --- a/src/lib/server/controllers/SubjectController.ts +++ /dev/null @@ -1 +0,0 @@ -export default {}; diff --git a/src/lib/server/controllers/index.ts b/src/lib/server/controllers/index.ts deleted file mode 100644 index 85bacfb..0000000 --- a/src/lib/server/controllers/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -export * as CourseController from './CourseController'; -export * as DomainController from './DomainController'; -export * as GraphController from './GraphController'; -export * as LectureController from './LectureController'; -export * as SubjectController from './SubjectController'; diff --git a/src/lib/server/helpers/CourseHelper.ts b/src/lib/server/helpers/CourseHelper.ts deleted file mode 100644 index 6072f7e..0000000 --- a/src/lib/server/helpers/CourseHelper.ts +++ /dev/null @@ -1,56 +0,0 @@ -import prisma from '$lib/server/prisma'; - -import { type SerializedCourse, type SerializedAssignedUser, Permissions } from '$scripts/entities'; -import type { Course } from '@prisma/client'; - - -export async function create(code: string, name: string, programId: number) { - await prisma.course.create({ - data: { - code, - name, - program: { - connect: { - id: programId - } - } - } - }); -} - - -async function getSerializedUsers(course: Course): Promise { - const user = (await prisma.user.findMany({ - where: { - programs: { - some: { - courses: { - some: { - id: course.id - } - } - } - } - }, - orderBy: { - id: 'asc' - } - })); - return user.map(u => ({ - id: u.id, - netid: u.netid, - first_name: u.first_name, - last_name: u.last_name, - email: u.email ?? undefined, - permissions: Permissions.admin // TODO: join table for course-user permissions - })); -} - - -export async function toDTO(course: Course): Promise { - return { - code: course.code, - name: course.name, - users: await getSerializedUsers(course) - } -} diff --git a/src/lib/server/helpers/DomainHelper.ts b/src/lib/server/helpers/DomainHelper.ts deleted file mode 100644 index 640790c..0000000 --- a/src/lib/server/helpers/DomainHelper.ts +++ /dev/null @@ -1,114 +0,0 @@ -import prisma from '$lib/server/prisma'; - -import type { SerializedDomain } from '$scripts/entities'; -import type { Domain } from '@prisma/client'; - - -export async function create(graphId: number): Promise { - const domain = await prisma.domain.create({ - data: { - graph: { - connect: { - id: graphId - } - } - } - }); - return domain.id; -} - - -export async function remove(domainId: number): Promise { - await prisma.domain.delete({ - where: { - id: domainId - } - }); -} - - -/** - * Plain Domain objects dont have a children (many-to-many) field, - * this method makes them available. - * @param domain plain Domain object - * @returns the ids of the children of the domain - */ -async function getChildIds(domain: Domain): Promise { - return (await prisma.domain.findMany({ - where: { - parentDomains: { - some: { - id: domain.id - } - } - }, - orderBy: { - id: 'asc' - } - })).map(d => d.id); -} - - -/** - * Plain Domain objects dont have a parents (many-to-many) field, - * this method makes them available. - * @param domain plain Domain object - * @returns the ids of the parents of the domain - */ -async function getParentIds(domain: Domain): Promise { - return (await prisma.domain.findMany({ - where: { - childDomains: { - some: { - id: domain.id - } - } - }, - orderBy: { - id: 'asc' - } - })).map(d => d.id); -} - - -/** - * Converts a Domain object to a SerializedDomain object, which can be sent to the client. - * @param domain plain Domain object - * @returns SerializedDomain object - */ -export async function toDTO(domain: Domain): Promise { - return { - id: domain.id, - name: domain.name!, - x: domain.x, - y: domain.y, - style: domain.style!, - children: await getChildIds(domain), - parents: await getParentIds(domain) - } -} - - -/** - * Updates a Domain object in the database to a SerializedDomain object sent by the client. - * @param dto SerializedDomain object - */ -export async function updateFromDTO(dto: SerializedDomain): Promise { - await prisma.domain.update({ - where: { - id: dto.id - }, - data: { - name: dto.name, - x: dto.x, - y: dto.y, - style: dto.style, - childDomains: { - connect: dto.children.map(id => ({ id })) - }, - parentDomains: { - connect: dto.parents.map(id => ({ id })) - } - } - }); -} diff --git a/src/lib/server/helpers/GraphHelper.ts b/src/lib/server/helpers/GraphHelper.ts deleted file mode 100644 index 9e3245a..0000000 --- a/src/lib/server/helpers/GraphHelper.ts +++ /dev/null @@ -1,98 +0,0 @@ -import prisma from '$lib/server/prisma'; - -import type { SerializedGraph } from '$scripts/entities'; -import type { Graph, Domain, Subject, Lecture } from '@prisma/client'; - -import { DomainHelper, SubjectHelper, LectureHelper } from '$lib/server/helpers'; - - -export async function createWithCourseCode(courseCode: string, name: string) { - await prisma.graph.create({ - data: { - name, - course: { - connect: { - code: courseCode - } - } - } - }); -} - - -async function getDomains(graph: Graph): Promise { - return await prisma.domain.findMany({ - where: { - graphId: graph.id - }, - orderBy: { - id: 'asc' - } - }); -} - - -async function getSubjects(graph: Graph): Promise { - return await prisma.subject.findMany({ - where: { - graphId: graph.id - }, - orderBy: { - id: 'asc' - } - }); -} - - -async function getLectures(graph: Graph): Promise { - return await prisma.lecture.findMany({ - where: { - graphId: graph.id - }, - orderBy: { - id: 'asc' - } - }); -} - - -export async function toDTO(graph: Graph): Promise { - const domains = await Promise.all((await getDomains(graph)).map(d => DomainHelper.toDTO(d))); - const subjects = await Promise.all((await getSubjects(graph)).map(s => SubjectHelper.toDTO(s))); - const lectures = await Promise.all((await getLectures(graph)).map(l => LectureHelper.toDTO(l))); - - return { - id: graph.id, - name: graph.name, - domains, - subjects, - lectures - } -} - - -export async function updateFromDTO(dto: SerializedGraph): Promise { - await Promise.all([ - ...dto.domains.map(d => DomainHelper.updateFromDTO(d)), - ...dto.subjects.map(s => SubjectHelper.updateFromDTO(s)), - ...dto.lectures.map(l => LectureHelper.updateFromDTO(l)) - ]); - - await prisma.graph.update({ - where: { - id: dto.id - }, - data: { - name: dto.name, - domains: { - connect: dto.domains.map(d => ({ id: d.id })) - }, - subjects: { - connect: dto.subjects.map(s => ({ id: s.id })) - }, - lectures: { - connect: dto.lectures.map(l => ({ id: l.id })) - } - } - }); -} diff --git a/src/lib/server/helpers/LectureHelper.ts b/src/lib/server/helpers/LectureHelper.ts deleted file mode 100644 index b9264cf..0000000 --- a/src/lib/server/helpers/LectureHelper.ts +++ /dev/null @@ -1,67 +0,0 @@ -import prisma from '$lib/server/prisma'; - -import type { SerializedLecture } from '$scripts/entities'; -import type { Lecture } from '@prisma/client'; - - -export async function create(graphId: number): Promise { - const lecture = await prisma.lecture.create({ - data: { - graph: { - connect: { - id: graphId - } - } - } - }); - return lecture.id; -} - - -export async function remove(lectureId: number): Promise { - await prisma.lecture.delete({ - where: { - id: lectureId - } - }); -} - - -async function getSubjectIds(lecture: Lecture): Promise { - return (await prisma.subject.findMany({ - where: { - lectures: { - some: { - id: lecture.id - } - } - }, - orderBy: { - id: 'asc' - } - })).map(s => s.id); -} - - -export async function toDTO(lecture: Lecture): Promise { - return { - id: lecture.id, - name: lecture.name!, - subjects: await getSubjectIds(lecture) - } -} - - -export async function updateFromDTO(dto: SerializedLecture) { - await prisma.lecture.update({ - where: { - id: dto.id - }, - data: { - name: dto.name, - subjects: { - connect: dto.subjects.map(s => ({ id: s })) - } - } - }); -} diff --git a/src/lib/server/helpers/SubjectHelper.ts b/src/lib/server/helpers/SubjectHelper.ts deleted file mode 100644 index 5f073d4..0000000 --- a/src/lib/server/helpers/SubjectHelper.ts +++ /dev/null @@ -1,118 +0,0 @@ -import prisma from '$lib/server/prisma'; - -import type { SerializedSubject } from '$scripts/entities'; -import type { Subject } from '@prisma/client'; - - -export async function create(graphId: number): Promise { - const subject = await prisma.subject.create({ - data: { - graph: { - connect: { - id: graphId - } - } - } - }); - return subject.id; -} - - -export async function remove(subjectId: number): Promise { - await prisma.subject.delete({ - where: { - id: subjectId - } - }); -} - - -// TODO: what if a subject has no domain yet? -async function getDomainId(subject: Subject): Promise { - return (await prisma.subject.findUnique({ - where: { - id: subject.id - } - }))?.domainId!; -} - - -async function getChildIds(subject: Subject): Promise { - return (await prisma.subject.findMany({ - where: { - parentSubjects: { - some: { - id: subject.id - } - } - }, - orderBy: { - id: 'asc' - } - })).map(d => d.id); -} - - -async function getParentIds(subject: Subject): Promise { - return (await prisma.subject.findMany({ - where: { - childSubjects: { - some: { - id: subject.id - } - } - }, - orderBy: { - id: 'asc' - } - })).map(d => d.id); -} - - -/*** - * Converts a Subject object to a SerializedSubject object, which can be sent to the client. - * @param subject plain Subject object - * @returns SerializedSubject object - */ -export async function toDTO(subject: Subject): Promise { - return { - id: subject.id, - x: subject.x, - y: subject.y, - domain: await getDomainId(subject), - name: subject.name!, // TODO: what if a subject has no name? Validate before converting and throw error? - children: await getChildIds(subject), - parents: await getParentIds(subject) - } -} - - -/** - * Updates a Subject object in the database to a SerializedSubject object sent by the client. - * @param dto SerializedSubject object - */ -export async function updateFromDTO(dto: SerializedSubject): Promise { - const domain = dto.domain ? { - connect: { - id: dto.domain - } - } : undefined; - - await prisma.subject.update({ - where: { - id: dto.id - }, - data: { - x: dto.x, - y: dto.y, - domain, - name: dto.name, - childSubjects: { - connect: dto.children.map(id => ({ id })) - }, - parentSubjects: { - connect: dto.parents.map(id => ({ id })) - } - } - }); -} diff --git a/src/lib/server/helpers/index.ts b/src/lib/server/helpers/index.ts deleted file mode 100644 index 334cda3..0000000 --- a/src/lib/server/helpers/index.ts +++ /dev/null @@ -1,5 +0,0 @@ -export * as CourseHelper from './CourseHelper'; -export * as DomainHelper from './DomainHelper'; -export * as GraphHelper from './GraphHelper'; -export * as LectureHelper from './LectureHelper'; -export * as SubjectHelper from './SubjectHelper'; diff --git a/src/lib/stores/course.ts b/src/lib/stores/course.ts deleted file mode 100644 index 2051fa3..0000000 --- a/src/lib/stores/course.ts +++ /dev/null @@ -1,4 +0,0 @@ - -import { writable } from "svelte/store" -import type { Course } from "$scripts/entities" -export const course = writable() \ No newline at end of file diff --git a/src/lib/stores/graph.ts b/src/lib/stores/graph.ts deleted file mode 100644 index 322db4f..0000000 --- a/src/lib/stores/graph.ts +++ /dev/null @@ -1,4 +0,0 @@ - -import { writable } from "svelte/store" -import type { Graph } from "$scripts/entities" -export const graph = writable() \ No newline at end of file diff --git a/src/lib/stores/index.ts b/src/lib/stores/index.ts deleted file mode 100644 index 62db500..0000000 --- a/src/lib/stores/index.ts +++ /dev/null @@ -1,3 +0,0 @@ - -export { course } from './course' -export { graph } from './graph' \ No newline at end of file diff --git a/src/lib/styles/global.sass b/src/lib/styles/global.sass index 26e4047..e906575 100644 --- a/src/lib/styles/global.sass +++ b/src/lib/styles/global.sass @@ -82,12 +82,18 @@ ul flex-grow: 1 pointer-events: none +.grayed + text-align: center + color: $placeholder-color + .modal form display: grid grid-template: "label content" auto / 1fr 2fr place-items: center start row-gap: $form-small-gap + margin-top: $form-big-gap + & > label grid-column: label justify-self: end @@ -104,4 +110,4 @@ ul flex-flow: row nowrap grid-column: content - margin-top: $form-big-gap + margin-top: $form-medium-gap diff --git a/src/lib/styles/palette.sass b/src/lib/styles/palette.sass index 0806dc0..151d187 100644 --- a/src/lib/styles/palette.sass +++ b/src/lib/styles/palette.sass @@ -20,7 +20,7 @@ $light-gray-filter: brightness(0) saturate(100%) invert(100%) sepia(5%) saturate $gray-filter: brightness(0) saturate(100%) invert(96%) sepia(2%) saturate(786%) hue-rotate(189deg) brightness(90%) contrast(91%) $dark-gray-filter: brightness(0) saturate(100%) invert(38%) sepia(5%) saturate(274%) hue-rotate(202deg) brightness(90%) contrast(95%) $black-filter: brightness(0) saturate(100%) invert(3%) sepia(9%) saturate(637%) hue-rotate(169deg) brightness(96%) contrast(99%) - +$placeholder-color-filter: $gray-filter $purple-filter: brightness(0) saturate(100%) invert(43%) sepia(21%) saturate(473%) hue-rotate(194deg) brightness(93%) contrast(85%) $dark-purple-filter: brightness(0) saturate(100%) invert(34%) sepia(9%) saturate(1144%) hue-rotate(196deg) brightness(99%) contrast(84%) $red-filter: brightness(0) saturate(100%) invert(27%) sepia(82%) saturate(3338%) hue-rotate(349deg) brightness(101%) contrast(101%) diff --git a/src/lib/styles/variables.sass b/src/lib/styles/variables.sass index afdb1ab..19361e2 100644 --- a/src/lib/styles/variables.sass +++ b/src/lib/styles/variables.sass @@ -46,4 +46,5 @@ $input-thick-padding: 1rem $input-thin-padding: 0.5rem $input-icon-size: 1.1rem -$input-icon-padding: 0.25rem \ No newline at end of file +$input-icon-padding: 0.25rem +$total-icon-size: calc($input-icon-size + 2 * $input-icon-padding) \ No newline at end of file diff --git a/src/routes/[course]/[link]/+page.server.ts b/src/routes/[course]/[link]/+page.server.ts deleted file mode 100644 index 2f9adcb..0000000 --- a/src/routes/[course]/[link]/+page.server.ts +++ /dev/null @@ -1,19 +0,0 @@ - -// External imports -import prisma from '$lib/server/prisma' - -// Internal imports -import { GraphHelper } from '$lib/server/helpers' - -// Load -export const load = async ({ params }) => { - const graphId = 1 // TODO replace with actual graph id, once we have a way to get it - - const graph = await GraphHelper.toDTO( - (await prisma.graph.findUnique({ - where: { id: graphId } - }))! - ) - - return { graph } -} diff --git a/src/routes/[course]/[link]/+page.svelte b/src/routes/[course]/[link]/+page.svelte deleted file mode 100644 index 50196d1..0000000 --- a/src/routes/[course]/[link]/+page.svelte +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/src/routes/[course]/[link]/+page.ts b/src/routes/[course]/[link]/+page.ts deleted file mode 100644 index d7f4a11..0000000 --- a/src/routes/[course]/[link]/+page.ts +++ /dev/null @@ -1,12 +0,0 @@ - -// Svelte imports -import type { PageLoad } from './$types' - -// Internal imports -import { Graph } from '$scripts/entities' -import { graph } from '$stores' - -// load -export const load: PageLoad = ({ data }) => { - graph.set(Graph.revive(data.graph)) -} \ No newline at end of file diff --git a/src/routes/api/course/+server.ts b/src/routes/api/course/+server.ts new file mode 100644 index 0000000..794ac2f --- /dev/null +++ b/src/routes/api/course/+server.ts @@ -0,0 +1,71 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { CourseHelper } from '$scripts/helpers' +import { instanceOfSerializedCourse } from '$scripts/types' + +// Exports +export { POST, PUT, GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for creating a new Course in the database. + * @body `{ code: string, name: string }` + * @returns `SerializedCourse` + */ + +async function POST({ request }) { + if (env.DEBUG) console.log('\nPOST /api/course') + + // Retrieve course code and name + const { code, name } = await request.json() + if (!code || !name) return new Response('Missing code or name', { status: 400 }) + + // Create course + return await CourseHelper.create(code, name) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for updating a Course in the database. + * @body `SerializedCourse` + */ + +async function PUT({ request }) { + if (env.DEBUG) console.log('\nPUT /api/course') + + // Retrieve data + const data = await request.json() + if (!instanceOfSerializedCourse(data)) { + return new Response('Invalid SerializedCourse', { status: 400 }) + } + + // Update course + return await CourseHelper.update(data) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for requesting all Courses in the database. + * @returns `SerializedCourses[]` + */ + +async function GET() { + if (env.DEBUG) console.log('\nGET /api/course') + + // Get all courses + return await CourseHelper.getAll() + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/course/[id]/+server.ts b/src/routes/api/course/[id]/+server.ts new file mode 100644 index 0000000..b2bc01b --- /dev/null +++ b/src/routes/api/course/[id]/+server.ts @@ -0,0 +1,54 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { CourseHelper } from '$scripts/helpers' + +// Exports +export { GET, DELETE } + + +// --------------------> API Endpoints + + +/** + * API endpoint for fetching a Course from the database. + * @returns `SerializedCourse` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/course/[id]') + + // Retrieve course ID + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Get the course + return await CourseHelper.getById(id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for deleting a Course from the database. + */ + +async function DELETE({ params }) { + if (env.DEBUG) console.log('\nDELETE /api/course/[id]') + + // Retrieve course ID + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the course + return await CourseHelper.remove(id) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/course/[id]/admins/+server.ts b/src/routes/api/course/[id]/admins/+server.ts new file mode 100644 index 0000000..8858e5a --- /dev/null +++ b/src/routes/api/course/[id]/admins/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { CourseHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all admins for a course + * @returns `SerializedUser[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/course/[id]/admins') + + // Retrieve course ID + const course_id = Number(params.id) + if (!course_id || isNaN(course_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + // Get all admins for the course + return await CourseHelper.getAdmins(course_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/course/[id]/editors/+server.ts b/src/routes/api/course/[id]/editors/+server.ts new file mode 100644 index 0000000..b77ff15 --- /dev/null +++ b/src/routes/api/course/[id]/editors/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { CourseHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all editors for a course + * @returns `SerializedUser[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/course/[id]/editors') + + // Retrieve course ID + const course_id = Number(params.id) + if (!course_id || isNaN(course_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + // Get all editors for the course + return await CourseHelper.getEditors(course_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/course/[id]/graphs/+server.ts b/src/routes/api/course/[id]/graphs/+server.ts new file mode 100644 index 0000000..ed3d947 --- /dev/null +++ b/src/routes/api/course/[id]/graphs/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { CourseHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all graphs for a course + * @returns `SerializedGraphs[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/course/[id]/graphs') + + // Retrieve course ID + const course_id = Number(params.id) + if (!course_id || isNaN(course_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + // Get all graphs for the course + return await CourseHelper.getGraphs(course_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/course/[id]/links/+server.ts b/src/routes/api/course/[id]/links/+server.ts new file mode 100644 index 0000000..3b320a5 --- /dev/null +++ b/src/routes/api/course/[id]/links/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { CourseHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all links for a course + * @returns `SerializedLink[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/course/[id]/links') + + // Retrieve course ID + const course_id = Number(params.id) + if (!course_id || isNaN(course_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + // Get all links for the course + return await CourseHelper.getLinks(course_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/course/[id]/programs/+server.ts b/src/routes/api/course/[id]/programs/+server.ts new file mode 100644 index 0000000..2b1d055 --- /dev/null +++ b/src/routes/api/course/[id]/programs/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { CourseHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all programs for a course + * @returns `SerializedProgram[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/course/[id]/programs') + + // Retrieve course ID + const course_id = Number(params.id) + if (!course_id || isNaN(course_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + // Get all programs for the course + return await CourseHelper.getPrograms(course_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/domain/+server.ts b/src/routes/api/domain/+server.ts new file mode 100644 index 0000000..5baa323 --- /dev/null +++ b/src/routes/api/domain/+server.ts @@ -0,0 +1,72 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { DomainHelper } from '$scripts/helpers' +import { instanceOfSerializedDomain } from '$scripts/types' + +// Exports +export { POST, PUT, GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for creating a new Domain in the database. + * @body `{ graph: number }` + * @returns `SerializedDomain` + */ + +async function POST({ request }) { + if (env.DEBUG) console.log('\nPOST /api/domain') + + // Retrieve graph ID + const { graph } = await request.json() + if (!graph || isNaN(graph)) + return new Response('Failed to create Domain: missing Graph ID', { status: 400 }) + + // Create graph + return await DomainHelper.create(graph) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for updating a Domain in the database. + * @body `SerializedDomain` + */ + +async function PUT({ request }) { + if (env.DEBUG) console.log('\nPUT /api/domain') + + // Retrieve data + const data = await request.json() + if (!instanceOfSerializedDomain(data)) { + return new Response('Invalid SerializedDomain', { status: 400 }) + } + + // Update domain + return await DomainHelper.update(data) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for requesting Domains in the database. + * @returns `SerializedDomain[]` or `SerializedDomain` if a single ID is provided + */ + +async function GET() { + if (env.DEBUG) console.log('\nGET /api/domain') + + // Get all domains + return await DomainHelper.getAll() + .then( + domains => new Response(JSON.stringify(domains), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/domain/[id=number]/+server.ts b/src/routes/api/domain/[id=number]/+server.ts deleted file mode 100644 index 9d74097..0000000 --- a/src/routes/api/domain/[id=number]/+server.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { DomainHelper } from '$lib/server/helpers'; - -export async function DELETE({ params }) { - const id = Number(params.id); - await DomainHelper.remove(id); - return new Response(null, { status: 200 }); -} diff --git a/src/routes/api/domain/[id]/+server.ts b/src/routes/api/domain/[id]/+server.ts new file mode 100644 index 0000000..66fa189 --- /dev/null +++ b/src/routes/api/domain/[id]/+server.ts @@ -0,0 +1,54 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { DomainHelper } from '$scripts/helpers' + +// Exports +export { GET, DELETE } + + +// --------------------> API Endpoints + + +/** + * API endpoint for fetching a Domain from the database. + * @returns `SerializedDomain` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/domain/[id]') + + // Retrieve domain ID + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the domain + return await DomainHelper.getById(id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for deleting a Domain from the database. + */ + +async function DELETE({ params }) { + if (env.DEBUG) console.log('\nDELETE /api/domain/[id]') + + // Retrieve domain ID + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the domain + return await DomainHelper.remove(id) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/domain/[id]/children/+server.ts b/src/routes/api/domain/[id]/children/+server.ts new file mode 100644 index 0000000..5d44796 --- /dev/null +++ b/src/routes/api/domain/[id]/children/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { DomainHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the children of a Domain + * @returns `SerializedDomain[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/domain/[id]/children') + + // Get the domain ID + const domain_id = Number(params.id) + if (!domain_id || isNaN(domain_id)) { + return new Response('Invalid domain ID', { status: 400 }) + } + + // Get all children of the domain + return await DomainHelper.getChildren(domain_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/domain/[id]/graph/+server.ts b/src/routes/api/domain/[id]/graph/+server.ts new file mode 100644 index 0000000..1f7be25 --- /dev/null +++ b/src/routes/api/domain/[id]/graph/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { DomainHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the Graph this Domain belongs to + * @returns `SerializedGraph` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/domain/[id]/graph') + + // Get the domain ID + const domain_id = Number(params.id) + if (!domain_id || isNaN(domain_id)) { + return new Response('Invalid domain ID', { status: 400 }) + } + + // Get the graph this domain belongs to + return await DomainHelper.getGraph(domain_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/domain/[id]/parents/+server.ts b/src/routes/api/domain/[id]/parents/+server.ts new file mode 100644 index 0000000..bf12ad8 --- /dev/null +++ b/src/routes/api/domain/[id]/parents/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { DomainHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the parents of a Domain + * @returns `SerializedDomain[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/domain/[id]/parents') + + // Get the domain ID + const domain_id = Number(params.id) + if (!domain_id || isNaN(domain_id)) { + return new Response('Invalid domain ID', { status: 400 }) + } + + // Get all parents of the domain + return await DomainHelper.getParents(domain_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/domain/[id]/subjects/+server.ts b/src/routes/api/domain/[id]/subjects/+server.ts new file mode 100644 index 0000000..d61ae6a --- /dev/null +++ b/src/routes/api/domain/[id]/subjects/+server.ts @@ -0,0 +1,33 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { DomainHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the Subjects of a Domain + * @returns `SerializedSubject[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/domain/[id]/subjects') + + // Get the domain ID + const domain_id = Number(params.id) + if (!domain_id || isNaN(domain_id)) { + return new Response('Invalid domain ID', { status: 400 }) + } + + // Get all subjects of the domain + return await DomainHelper.getSubjects(domain_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/graph/+server.ts b/src/routes/api/graph/+server.ts new file mode 100644 index 0000000..dadab49 --- /dev/null +++ b/src/routes/api/graph/+server.ts @@ -0,0 +1,71 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { GraphHelper } from '$scripts/helpers' +import { instanceOfSerializedGraph } from '$scripts/types' + +// Exports +export { POST, PUT, GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for creating a new Graph in the database. + * @body `{ course: number, name: string }` + * @returns `SerializedGraph` + */ + +async function POST({ request }) { + if (env.DEBUG) console.log('\nPOST /api/graph') + + // Retrieve data + const { course, name } = await request.json() + if (!course || !name || isNaN(course)) + return new Response('Missing course or name', { status: 400 }) + + // Create graph + return await GraphHelper.create(course, name) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for updating a Graph in the database. + * @body `SerializedGraph` + */ + +async function PUT({ request }) { + if (env.DEBUG) console.log('\nPUT /api/graph') + + // Retrieve data + const data = await request.json() + if (!instanceOfSerializedGraph(data)) { + return new Response('Invalid SerializedGraph', { status: 400 }) + } + + // Update domain + return await GraphHelper.update(data) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for requesting Graphs in the database. + * @returns `SerializedGraph[]` or `SerializedGraph` if a single ID is provided + */ + +async function GET() { + if (env.DEBUG) console.log('\nGET /api/graph') + + return await GraphHelper.getAll() + .then( + graphs => new Response(JSON.stringify(graphs), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/graph/[id=number]/+server.ts b/src/routes/api/graph/[id=number]/+server.ts deleted file mode 100644 index 0d3382b..0000000 --- a/src/routes/api/graph/[id=number]/+server.ts +++ /dev/null @@ -1,29 +0,0 @@ -import { json, error } from '@sveltejs/kit'; - -import { GraphHelper } from '$lib/server/helpers'; -import { getGraphById } from '$lib/server/controllers/GraphController'; -import { type SerializedGraph } from '$scripts/entities'; - - -/** - * Fetches a graph by its ID and returns it as a DTO - */ -export async function GET({ params }): Promise { - const id = Number(params.id); - const graph = await getGraphById(id); - return json(graph); -} - - -/** - * Updates a graph from a DTO - */ -export async function PUT({ request, params }): Promise { - const id = Number(params.id); - const dto: SerializedGraph = await request.json(); - - if (id !== dto.id) error(400, 'ID mismatch'); - - await GraphHelper.updateFromDTO(dto); - return new Response(null, { status: 201 }); -} diff --git a/src/routes/api/graph/[id]/+server.ts b/src/routes/api/graph/[id]/+server.ts new file mode 100644 index 0000000..9d89f92 --- /dev/null +++ b/src/routes/api/graph/[id]/+server.ts @@ -0,0 +1,54 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { GraphHelper } from '$scripts/helpers' + +// Exports +export { GET, DELETE } + + +// --------------------> API Endpoints + + +/** + * API endpoint for fetching a Graph from the database. + * @returns `SerializedGraph` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/graph/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the graph + return await GraphHelper.getById(id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for deleting a Graph from the database. + */ + +async function DELETE({ params }) { + if (env.DEBUG) console.log('\nDELETE /api/graph/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the graph + return await GraphHelper.remove(id) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/graph/[id]/course/+server.ts b/src/routes/api/graph/[id]/course/+server.ts new file mode 100644 index 0000000..ae2bbf4 --- /dev/null +++ b/src/routes/api/graph/[id]/course/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { GraphHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting all Subjects belonging to target graph + * @returns `SerializedCourse` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/graph/[id]/course') + + const graph_id = Number(params.id) + if (!graph_id || isNaN(graph_id)) { + return new Response('Invalid graph ID', { status: 400 }) + } + + return await GraphHelper.getCourse(graph_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/graph/[id]/domains/+server.ts b/src/routes/api/graph/[id]/domains/+server.ts new file mode 100644 index 0000000..1ee1a99 --- /dev/null +++ b/src/routes/api/graph/[id]/domains/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { GraphHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting all Domains belonging to target graph + * @returns `SerializedDomain[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/graph/[id]/domains') + + const graph_id = Number(params.id) + if (!graph_id || isNaN(graph_id)) { + return new Response('Invalid graph ID', { status: 400 }) + } + + return await GraphHelper.getDomains(graph_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/graph/[id]/lectures/+server.ts b/src/routes/api/graph/[id]/lectures/+server.ts new file mode 100644 index 0000000..34f5f94 --- /dev/null +++ b/src/routes/api/graph/[id]/lectures/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { GraphHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting all Lectures belonging to target graph + * @returns `SerializedLecture[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/graph/[id]/lectures') + + const graph_id = Number(params.id) + if (!graph_id || isNaN(graph_id)) { + return new Response('Invalid graph ID', { status: 400 }) + } + + return await GraphHelper.getLectures(graph_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/graph/[id]/links/+server.ts b/src/routes/api/graph/[id]/links/+server.ts new file mode 100644 index 0000000..2b94523 --- /dev/null +++ b/src/routes/api/graph/[id]/links/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { GraphHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting all Subjects belonging to target graph + * @returns `SerializedLink[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/graph/[id]/links') + + const graph_id = Number(params.id) + if (!graph_id || isNaN(graph_id)) { + return new Response('Invalid graph ID', { status: 400 }) + } + + return await GraphHelper.getLinks(graph_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/graph/[id]/subjects/+server.ts b/src/routes/api/graph/[id]/subjects/+server.ts new file mode 100644 index 0000000..2b5737d --- /dev/null +++ b/src/routes/api/graph/[id]/subjects/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { GraphHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting all Subjects belonging to target graph + * @returns `SerializedSubject[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/graph/[id]/subjects') + + const graph_id = Number(params.id) + if (!graph_id || isNaN(graph_id)) { + return new Response('Invalid graph ID', { status: 400 }) + } + + return await GraphHelper.getSubjects(graph_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/lecture/+server.ts b/src/routes/api/lecture/+server.ts new file mode 100644 index 0000000..016b42f --- /dev/null +++ b/src/routes/api/lecture/+server.ts @@ -0,0 +1,71 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LectureHelper } from '$scripts/helpers' +import { instanceOfSerializedLecture } from '$scripts/types' + +// Exports +export { POST, PUT, GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for creating a new Lecture in the database. + * @body `{ graph: number }` + * @returns `SerializedLecture` + */ + +async function POST({ request }) { + if (env.DEBUG) console.log('\nPOST /api/lecture') + + // Retrieve data + const { graph } = await request.json() + if (!graph || isNaN(graph)) + return new Response('Missing graph id', { status: 400 }) + + // Create graph + return await LectureHelper.create(graph) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for updating a lecture in the database. + * @body `SerializedLecture` + */ + +async function PUT({ request }) { + if (env.DEBUG) console.log('\nPUT /api/lecture') + + // Retrieve data + const data = await request.json() + if (!instanceOfSerializedLecture(data)) { + return new Response('Invalid SerializedLecture', { status: 400 }) + } + + // Update domain + return await LectureHelper.update(data) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for requesting all Lectures in the database. + * @returns `SerializedLecture[]` + */ + +async function GET() { + if (env.DEBUG) console.log('\nGET /api/lecture') + + return await LectureHelper.getAll() + .then( + graphs => new Response(JSON.stringify(graphs), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/lecture/[id=number]/+server.ts b/src/routes/api/lecture/[id=number]/+server.ts deleted file mode 100644 index 100e3b9..0000000 --- a/src/routes/api/lecture/[id=number]/+server.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { LectureHelper } from '$lib/server/helpers'; - -export async function DELETE({ params }) { - const id = Number(params.id); - await LectureHelper.remove(id); - return new Response(null, { status: 200 }); -} diff --git a/src/routes/api/lecture/[id]/+server.ts b/src/routes/api/lecture/[id]/+server.ts new file mode 100644 index 0000000..f3dbbba --- /dev/null +++ b/src/routes/api/lecture/[id]/+server.ts @@ -0,0 +1,54 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LectureHelper } from '$scripts/helpers' + +// Exports +export { GET, DELETE } + + +// --------------------> API Endpoints + + +/** + * API endpoint for fetching a Lecture from the database. + * @returns `SerializedLecture` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/lecture/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the lecture + return await LectureHelper.getById(id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for deleting a Lecture from the database. + */ + +async function DELETE({ params }) { + if (env.DEBUG) console.log('\nDELETE /api/lecture/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the lecture + return await LectureHelper.remove(id) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/lecture/[id]/graph/+server.ts b/src/routes/api/lecture/[id]/graph/+server.ts new file mode 100644 index 0000000..a4cc267 --- /dev/null +++ b/src/routes/api/lecture/[id]/graph/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LectureHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the Graph this Lecture belongs to + * @returns `SerializedGraph` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/lecture/[id]/graph') + + const lecture_id = Number(params.id) + if (!lecture_id || isNaN(lecture_id)) { + return new Response('Invalid lecture ID', { status: 400 }) + } + + return await LectureHelper.getGraph(lecture_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/lecture/[id]/subjects/+server.ts b/src/routes/api/lecture/[id]/subjects/+server.ts new file mode 100644 index 0000000..72ebd16 --- /dev/null +++ b/src/routes/api/lecture/[id]/subjects/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LectureHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the Subjects of a Lecture + * @returns `SerializedSubject[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/lecture/[id]/subjects') + + const lecture_id = Number(params.id) + if (!lecture_id || isNaN(lecture_id)) { + return new Response('Invalid lecture ID', { status: 400 }) + } + + return await LectureHelper.getSubjects(lecture_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/link/+server.ts b/src/routes/api/link/+server.ts new file mode 100644 index 0000000..45af383 --- /dev/null +++ b/src/routes/api/link/+server.ts @@ -0,0 +1,71 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LinkHelper } from '$scripts/helpers' +import { instanceOfSerializedLink } from '$scripts/types' + +// Exports +export { POST, PUT, GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for creating a new Link in the database. + * @body `{ course: number, graph: number, name: string }` + * @returns `SerializedLink` + */ + +async function POST({ request }) { + if (env.DEBUG) console.log('\nPOST /api/link') + + // Retrieve data + const { course, graph, name } = await request.json() + if (!course || !name || isNaN(course)) + return new Response('Missing COURSE or name', { status: 400 }) + + // Create Link + return await LinkHelper.create(course, graph, name) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for updating a Link in the database. + * @body `SerializedLink` + */ + +async function PUT({ request }) { + if (env.DEBUG) console.log('\nPUT /api/link') + + // Retrieve data + const data = await request.json() + if (!instanceOfSerializedLink(data)) { + return new Response('Invalid SerializedLink', { status: 400 }) + } + + // Update Link + return await LinkHelper.update(data) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for requesting all Links in the database. + * @returns `SerializedLinks[]` + */ + +async function GET() { + if (env.DEBUG) console.log('\nGET /api/link') + + return await LinkHelper.getAll() + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/link/[id]/+server.ts b/src/routes/api/link/[id]/+server.ts new file mode 100644 index 0000000..a21daaf --- /dev/null +++ b/src/routes/api/link/[id]/+server.ts @@ -0,0 +1,54 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LinkHelper } from '$scripts/helpers' + +// Exports +export { GET, DELETE } + + +// --------------------> API Endpoints + + +/** + * API endpoint for fetching a Link from the database. + * @returns `SerializedLink` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/link/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the Link + return await LinkHelper.getById(id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for deleting a Link from the database. + */ + +async function DELETE({ params }) { + if (env.DEBUG) console.log('\nDELETE /api/link/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the Link + return await LinkHelper.remove(id) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/link/[id]/course/+server.ts b/src/routes/api/link/[id]/course/+server.ts new file mode 100644 index 0000000..b489658 --- /dev/null +++ b/src/routes/api/link/[id]/course/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LinkHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting Course target link belongs to + * @returns `SerializedCourse` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/link/[id]/course') + + const link_id = Number(params.id) + if (!link_id || isNaN(link_id)) { + return new Response('Invalid link ID', { status: 400 }) + } + + return await LinkHelper.getCourse(link_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/link/[id]/graph/+server.ts b/src/routes/api/link/[id]/graph/+server.ts new file mode 100644 index 0000000..1278475 --- /dev/null +++ b/src/routes/api/link/[id]/graph/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { LinkHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpont for getting Graph belonging to target link + * @returns `SerializedGraph` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/link/[id]/graph') + + const link_id = Number(params.id) + if (!link_id || isNaN(link_id)) { + return new Response('Invalid link ID', { status: 400 }) + } + + return await LinkHelper.getGraph(link_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/program/+server.ts b/src/routes/api/program/+server.ts new file mode 100644 index 0000000..c418797 --- /dev/null +++ b/src/routes/api/program/+server.ts @@ -0,0 +1,70 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { ProgramHelper } from '$scripts/helpers' +import { instanceOfSerializedProgram } from '$scripts/types' + +// Exports +export { POST, PUT, GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for creating a Program in the database. + * @body `{ name: string }` + * @returns `SerializedProgram` + */ + +async function POST({ request }) { + if (env.DEBUG) console.log('\nPOST /api/program') + + // Retrieve data + const { name } = await request.json() + if (!name) return new Response('Missing name', { status: 400 }) + + // Create the program + return await ProgramHelper.create(name) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for updating a Program in the database. + * @body `SerializedProgram` + */ + +async function PUT({ request }) { + if (env.DEBUG) console.log('\nPUT /api/program') + + // Retrieve data + const data = await request.json() + if (!instanceOfSerializedProgram(data)) { + return new Response('Invalid SerializedProgram', { status: 400 }) + } + + // Update program + return await ProgramHelper.update(data) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for requesting all Programs in the database. + * @returns `SerializedProgram[]` + */ + +async function GET() { + if (env.DEBUG) console.log('\nGET /api/program') + + return await ProgramHelper.getAll() + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/program/[id]/+server.ts b/src/routes/api/program/[id]/+server.ts new file mode 100644 index 0000000..4fc3eea --- /dev/null +++ b/src/routes/api/program/[id]/+server.ts @@ -0,0 +1,54 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { ProgramHelper } from '$scripts/helpers' + +// Exports +export { GET, DELETE } + + +// --------------------> API Endpoints + + +/** + * API endpoint for fetching a Program from the database. + * @returns `SerializedProgram` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/program/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the program + return await ProgramHelper.getById(id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for deleting a Program from the database. + */ + +async function DELETE({ params }) { + if (env.DEBUG) console.log('\nDELETE /api/program/[id]') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the program + return await ProgramHelper.remove(id) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/program/[id]/admins/+server.ts b/src/routes/api/program/[id]/admins/+server.ts new file mode 100644 index 0000000..df385f6 --- /dev/null +++ b/src/routes/api/program/[id]/admins/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { ProgramHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all admins for a program + * @returns `SerializedUser[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/program/[id]/admins') + + const program_id = Number(params.id) + if (!program_id || isNaN(program_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + return await ProgramHelper.getAdmins(program_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/program/[id]/courses/+server.ts b/src/routes/api/program/[id]/courses/+server.ts new file mode 100644 index 0000000..69de3e5 --- /dev/null +++ b/src/routes/api/program/[id]/courses/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { ProgramHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all courses for a program + * @returns `SerializedCourse[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/program/[id]/courses') + + const program_id = Number(params.id) + if (!program_id || isNaN(program_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + return await ProgramHelper.getCourses(program_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/program/[id]/editors/+server.ts b/src/routes/api/program/[id]/editors/+server.ts new file mode 100644 index 0000000..7d3c2ac --- /dev/null +++ b/src/routes/api/program/[id]/editors/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { ProgramHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * Get all editors for a program + * @returns `SerializedUser[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/program/[id]/editors') + + const program_id = Number(params.id) + if (!program_id || isNaN(program_id)) { + return new Response('Invalid program ID', { status: 400 }) + } + + return await ProgramHelper.getEditors(program_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/subject/+server.ts b/src/routes/api/subject/+server.ts new file mode 100644 index 0000000..7a18fd9 --- /dev/null +++ b/src/routes/api/subject/+server.ts @@ -0,0 +1,71 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { SubjectHelper } from '$scripts/helpers' +import { instanceOfSerializedSubject } from '$scripts/types' + +// Exports +export { POST, PUT, GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for creating a new Subject in the database. + * @body `{ graph: number }` + * @returns `SerializedSubject` + */ + +async function POST({ request }) { + if (env.DEBUG) console.log('\nPOST /api/subject') + + // Retrieve data + const { graph } = await request.json() + if (!graph || isNaN(graph)) + return new Response('Failed to create Subject: missing Graph ID', { status: 400 }) + + // Create graph + return await SubjectHelper.create(graph) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for updating a Subject in the database. + * @body `SerializedSubject` + */ + +async function PUT({ request }) { + if (env.DEBUG) console.log('\nPUT /api/subject') + + // Retrieve data + const data = await request.json() + if (!instanceOfSerializedSubject(data)) { + return new Response('Invalid SerializedSubject', { status: 400 }) + } + + // Update subject + return await SubjectHelper.update(data) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for requesting Subjects in the database. + * @returns `SerializedSubject[]` or `SerializedSubject` if a single ID is provided + */ + +async function GET() { + if (env.DEBUG) console.log('\nGET /api/subject') + + return await SubjectHelper.getAll() + .then( + subjects => new Response(JSON.stringify(subjects), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/subject/[id=number]/+server.ts b/src/routes/api/subject/[id=number]/+server.ts deleted file mode 100644 index afdec83..0000000 --- a/src/routes/api/subject/[id=number]/+server.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { SubjectHelper } from '$lib/server/helpers'; - -export async function DELETE({ params }) { - const id = Number(params.id); - await SubjectHelper.remove(id); - return new Response(null, { status: 200 }); -} diff --git a/src/routes/api/subject/[id]/+server.ts b/src/routes/api/subject/[id]/+server.ts new file mode 100644 index 0000000..72ea693 --- /dev/null +++ b/src/routes/api/subject/[id]/+server.ts @@ -0,0 +1,54 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { SubjectHelper } from '$scripts/helpers' + +// Exports +export { GET, DELETE } + + +// --------------------> API Endpoints + + +/** + * API endpoint for fetching a Subject from the database. + * @returns `SerializedSubject` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/subject') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the subject + return await SubjectHelper.getById(id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} + +/** + * API endpoint for deleting a Subject from the database. + */ + +async function DELETE({ params }) { + if (env.DEBUG) console.log('\nDELETE /api/subject') + + // Retrieve data + const id = Number(params.id) + if (!id || isNaN(id)) { + return new Response('Missing ID', { status: 400 }) + } + + // Delete the subject + return await SubjectHelper.remove(id) + .then( + () => new Response(null, { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/subject/[id]/children/+server.ts b/src/routes/api/subject/[id]/children/+server.ts new file mode 100644 index 0000000..4258d9f --- /dev/null +++ b/src/routes/api/subject/[id]/children/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { SubjectHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the children of a Subject + * @returns `SerializedSubject[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/subject/[id]/children') + + const subject_id = Number(params.id) + if (!subject_id || isNaN(subject_id)) { + return new Response('Invalid subject ID', { status: 400 }) + } + + return await SubjectHelper.getChildren(subject_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/subject/[id]/domain/+server.ts b/src/routes/api/subject/[id]/domain/+server.ts new file mode 100644 index 0000000..4e5b436 --- /dev/null +++ b/src/routes/api/subject/[id]/domain/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { SubjectHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the Domain this Subject belongs to + * @returns `SerializedDomain` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/subject/[id]/domain') + + const subject_id = Number(params.id) + if (!subject_id || isNaN(subject_id)) { + return new Response('Invalid subject ID', { status: 400 }) + } + + return await SubjectHelper.getDomain(subject_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/subject/[id]/graph/+server.ts b/src/routes/api/subject/[id]/graph/+server.ts new file mode 100644 index 0000000..4d929a8 --- /dev/null +++ b/src/routes/api/subject/[id]/graph/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { SubjectHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the Graph this Subject belongs to + * @returns `SerializedGraph` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/subject/[id]/graph') + + const subject_id = Number(params.id) + if (!subject_id || isNaN(subject_id)) { + return new Response('Invalid subject ID', { status: 400 }) + } + + return await SubjectHelper.getGraph(subject_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/subject/[id]/lectures/+server.ts b/src/routes/api/subject/[id]/lectures/+server.ts new file mode 100644 index 0000000..9b31c5e --- /dev/null +++ b/src/routes/api/subject/[id]/lectures/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { SubjectHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the Lectures of a Subject + * @returns `SerializedLecture[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/subject/[id]/lectures') + + const subject_id = Number(params.id) + if (!subject_id || isNaN(subject_id)) { + return new Response('Invalid subject ID', { status: 400 }) + } + + return await SubjectHelper.getLectures(subject_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/api/subject/[id]/parents/+server.ts b/src/routes/api/subject/[id]/parents/+server.ts new file mode 100644 index 0000000..df4ead3 --- /dev/null +++ b/src/routes/api/subject/[id]/parents/+server.ts @@ -0,0 +1,31 @@ + +// Internal dependencies +import { env } from '$env/dynamic/private' +import { SubjectHelper } from '$scripts/helpers' + +// Exports +export { GET } + + +// --------------------> API Endpoints + + +/** + * API endpoint for getting the parents of a Subject + * @returns `SerializedSubject[]` + */ + +async function GET({ params }) { + if (env.DEBUG) console.log('\nGET /api/subject/[id]/parents') + + const subject_id = Number(params.id) + if (!subject_id || isNaN(subject_id)) { + return new Response('Invalid subject ID', { status: 400 }) + } + + return await SubjectHelper.getParents(subject_id) + .then( + data => new Response(JSON.stringify(data), { status: 200 }), + error => new Response(error, { status: 400 }) + ) +} \ No newline at end of file diff --git a/src/routes/app/+layout.svelte b/src/routes/app/+layout.svelte index 4b40974..980e651 100644 --- a/src/routes/app/+layout.svelte +++ b/src/routes/app/+layout.svelte @@ -1,8 +1,9 @@ + - - - - -

Login

- - - -
- -