EW-539 working on file builder

apps/server/src/modules/learnroom/common-cartridge/temp/builders/common-cartridge-file-builder.spec.ts

@@ -42,6 +42,18 @@ describe('CommonCartridgeFileBuilder', () => {
 				expect(manifest).toContain('<organizations>');
 				expect(manifest).toContain('</organizations>');
 			});
+
+			it('foobar', () => {
+				// const builder = new CommonCartridgeFileBuilder(CommonCartridgeVersion.V_1_1);
+				// const metadataBuilder = builder.withMetadata();
+				// metadataBuilder
+				// 	.setTitle('test-title')
+				// 	.setCopyrightOwners(['PS', 'SR'])
+				// 	.setCreationDate(new Date('2021-01-01'));
+				// const organization1Builder = builder.withOrganization();
+				// const organization2Builder = builder.withOrganization();
+				// organization1Builder.addOrganization()
+			});
 		});
 	});
 });

apps/server/src/modules/learnroom/common-cartridge/temp/builders/common-cartridge-manifest-builder.ts

@@ -2,55 +2,27 @@ import { CommonCartridgeVersion } from '../common-cartridge.enums';
 import { CommonCartridgeElement } from '../interfaces/common-cartridge-element.interface';
 import { CommonCartridgeResource } from '../interfaces/common-cartridge-resource.interface';
 import { CommonCartridgeManifestResource } from '../resources/common-cartridge-manifest-resource';
-import { checkDefined } from '../utils';
 
-export class CommonCartridgeManifestBuilder {
-	private identifier?: string;
-
-	private metadata?: CommonCartridgeElement;
-
-	private organizations?: CommonCartridgeElement[];
-
-	private resources?: CommonCartridgeResource[];
-
-	constructor(private readonly version: CommonCartridgeVersion) {}
+type CommonCartridgeManifestBuilderProps = {
+	version: CommonCartridgeVersion;
+	identifier: string;
+	metadata: CommonCartridgeElement;
+	organizations: CommonCartridgeElement[];
+	resources: CommonCartridgeResource[];
+};
 
-	setIdentifier(identifier: string): CommonCartridgeManifestBuilder {
-		this.identifier = identifier;
-
-		return this;
-	}
-
-	setMetadata(metadata: CommonCartridgeElement): CommonCartridgeManifestBuilder {
-		this.metadata = metadata;
-
-		return this;
-	}
-
-	setOrganizations(organizations: CommonCartridgeElement[]): CommonCartridgeManifestBuilder {
-		this.organizations = organizations;
-
-		return this;
-	}
-
-	setResources(resources: CommonCartridgeResource[]): CommonCartridgeManifestBuilder {
-		this.resources = resources;
-
-		return this;
-	}
+export class CommonCartridgeManifestBuilder {
+	constructor(private readonly props: CommonCartridgeManifestBuilderProps) {}
 
 	build(): CommonCartridgeResource {
-		const identifier = checkDefined(this.identifier, 'Identifier');
-		const metadata = checkDefined(this.metadata, 'Metadata');
-		const organizations = checkDefined(this.organizations, 'Organizations');
-		const resources = checkDefined(this.resources, 'Resources');
-
-		return new CommonCartridgeManifestResource({
-			version: this.version,
-			identifier,
-			metadata,
-			organizations,
-			resources,
+		const manifestResource = new CommonCartridgeManifestResource({
+			version: this.props.version,
+			identifier: this.props.identifier,
+			metadata: this.props.metadata,
+			organizations: this.props.organizations,
+			resources: this.props.resources,
 		});
+
+		return manifestResource;
 	}
 }

apps/server/src/modules/learnroom/common-cartridge/temp/builders/common-cartridge-organization-builder.ts

@@ -1,35 +1,22 @@
 import { CommonCartridgeVersion } from '../common-cartridge.enums';
 import { CommonCartridgeElement } from '../interfaces/common-cartridge-element.interface';
 import { CommonCartridgeResource } from '../interfaces/common-cartridge-resource.interface';
-import { checkDefined } from '../utils';
 
-export class CommonCartridgeOrganizationBuilder {
-	private title?: string;
-
-	private identifier?: string;
+type CommonCartridgeOrganizationProps = {
+	version: CommonCartridgeVersion;
+	title: string;
+	identifier: string;
+};
 
+export class CommonCartridgeOrganizationBuilder {
 	private items: CommonCartridgeResource[] = [];
 
 	private children: CommonCartridgeElement[] = [];
 
-	constructor(private readonly version: CommonCartridgeVersion, private readonly parent?: CommonCartridgeElement) {}
-
-	setIdentifier(identifier: string): CommonCartridgeOrganizationBuilder {
-		this.identifier = identifier;
-
-		return this;
-	}
-
-	setTitle(title: string): CommonCartridgeOrganizationBuilder {
-		this.title = title;
-
-		return this;
-	}
-
-	addOrganization(organization: CommonCartridgeElement): CommonCartridgeOrganizationBuilder {
-		this.items.push(organization);
+	constructor(private readonly props: CommonCartridgeOrganizationProps) {}
 
-		return new CommonCartridgeOrganizationBuilder(this.version);
+	addOrganization(props: CommonCartridgeOrganizationProps): CommonCartridgeOrganizationBuilder {
+		return new CommonCartridgeOrganizationBuilder(props);
 	}
 
 	addOrganizationItem(item: CommonCartridgeResource): CommonCartridgeOrganizationBuilder {

apps/server/src/modules/learnroom/common-cartridge/temp/interfaces/common-cartridge-element.interface.ts

@@ -6,5 +6,5 @@ export interface CommonCartridgeElement {
 	 * This method is used to build the imsmanifest.xml file.
 	 * @returns The XML object representation for the imsmanifest.xml file.
 	 */
-	getManifestXml(): Record<string, unknown> | undefined;
+	getManifestXml(): Record<string, unknown>;
 }

apps/server/src/modules/learnroom/common-cartridge/temp/resources/common-cartridge-manifest-resource.ts

@@ -31,7 +31,7 @@ export class CommonCartridgeManifestResource implements CommonCartridgeResource
 		return this.xmlBuilder.buildObject(this.getManifestXml());
 	}
 
-	getManifestXml(): Record<string, unknown> | undefined {
+	getManifestXml(): Record<string, unknown> {
 		return {
 			manifest: {
 				$: this.getXmlNamespacesByVersion(),

apps/server/src/modules/learnroom/common-cartridge/temp/resources/common-cartridge-organization-resource.ts

@@ -0,0 +1,21 @@
+import { CommonCartridgeElement } from '../interfaces/common-cartridge-element.interface';
+
+type CommonCartridgeOrganizationElementProps = {
+	identifier: string;
+	title: string;
+	items: CommonCartridgeElement[];
+};
+
+export class CommonCartridgeOrganizationElement implements CommonCartridgeElement {
+	constructor(private readonly props: CommonCartridgeOrganizationElementProps) {}
+
+	getManifestXml(): Record<string, unknown> {
+		return {
+			$: {
+				identifier: this.props.identifier,
+			},
+			title: this.props.title,
+			item: this.props.items.map((item) => item.getManifestXml()),
+		};
+	}
+}