Merge pull request #40 from diffusionstudio/konstantin/feat/source-metadata

Konstantin/feat/source metadata

Author: k9p5

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@diffusionstudio/core",
   "private": false,
-  "version": "1.1.3",
+  "version": "1.2.0",
   "type": "module",
   "description": "Build bleeding edge video processing applications",
   "files": [

package.json

@@ -86,7 +86,6 @@ export class AudioClip extends MediaClip<AudioClipProps> {
 
 	public copy(): AudioClip {
 		const clip = AudioClip.fromJSON(JSON.parse(JSON.stringify(this)));
-		clip.transcript = this.transcript;
 		clip.source = this.source;
 
 		return clip;

src/clips/audio/audio.ts

@@ -19,7 +19,7 @@ import type { MediaClipProps } from './media.interfaces';
 
 
 export class MediaClip<Props extends MediaClipProps = MediaClipProps> extends Clip<MediaClipProps> {
-	public readonly source = new AudioSource();
+	public source = new AudioSource();
 	public declare element?: HTMLAudioElement | HTMLVideoElement;
 
 	@serializable(Timestamp)
@@ -42,16 +42,22 @@ export class MediaClip<Props extends MediaClipProps = MediaClipProps> extends Cl
 	@serializable(RangeDeserializer)
 	public range: [Timestamp, Timestamp] = [new Timestamp(), this.duration];
 
+	public constructor(props: MediaClipProps = {}) {
+		super();
+
+		Object.assign(this, props);
+	}
+
 	/**
 	 * Defines the transcript of the video/audio
 	 */
 	@serializable(Transcript)
-	public transcript?: Transcript;
+	public get transcript(): Transcript | undefined {
+		return this.source.transcript;
+	};
 
-	public constructor(props: MediaClipProps = {}) {
-		super();
-
-		Object.assign(this, props);
+	public set transcript(transcript: Transcript | undefined) {
+		this.source.transcript = transcript;
 	}
 
 	public get start(): Timestamp {
@@ -234,7 +240,7 @@ export class MediaClip<Props extends MediaClipProps = MediaClipProps> extends Cl
 
 	public copy(): MediaClip {
 		const clip = MediaClip.fromJSON(JSON.parse(JSON.stringify(this)));
-		clip.transcript = this.transcript;
+		clip.source = this.source;
 		return clip;
 	}
 

src/clips/media/media.ts

@@ -142,7 +142,6 @@ export class VideoClip extends VisualMixin(MediaClip<VideoClipProps>) {
 		const clip = VideoClip.fromJSON(JSON.parse(JSON.stringify(this)));
 		clip.filters = this.filters;
 		clip.source = this.source;
-		clip.transcript = this.transcript;
 
 		return clip;
 	}

src/clips/video/video.ts

@@ -89,6 +89,13 @@ describe('AudioSource', () => {
 		}
 	});
 
+	it('should accept custom metadata', async () => {
+		const metadata = { a: 1, b: 2 };
+		const source = new AudioSource<typeof metadata>();
+		source.metadata = metadata;
+		expect(source.metadata).toEqual(metadata);
+	});
+
 	it('should create a thumbnail with correct DOM elements', async () => {
 		const thumbnail = await audioSource.thumbnail(60, 50, 0);
 

src/sources/audio.spec.ts

@@ -10,11 +10,13 @@ import { Source } from './source';
 import type { ClipType } from '../clips';
 import type { ArgumentTypes } from '../types';
 import type { FastSamplerOptions } from './audio.types';
+import type { Transcript } from '../models';
 
-export class AudioSource extends Source {
+export class AudioSource<T extends Object = {}> extends Source<T> {
+	public readonly type: ClipType = 'audio';
 	private decoding = false;
 
-	public readonly type: ClipType = 'audio';
+	public transcript?: Transcript;
 	public audioBuffer?: AudioBuffer;
 
 	public async decode(

src/sources/audio.ts

@@ -91,6 +91,13 @@ describe('The Html Source Object', () => {
 
 		expect(thumbnail).toBeInstanceOf(Image);
 	});
+
+	it('should accept custom metadata', async () => {
+		const metadata = { a: 1, b: 2 };
+		const source = new HtmlSource<typeof metadata>();
+		source.metadata = metadata;
+		expect(source.metadata).toEqual(metadata);
+	});
 });
 
 function mockIframeValid(source: HtmlSource) {

src/sources/html.spec.ts

@@ -10,7 +10,7 @@ import { documentToSvgImageUrl } from './html.utils';
 
 import type { ClipType } from '../clips';
 
-export class HtmlSource extends Source {
+export class HtmlSource<T extends Object = {}> extends Source<T> {
 	public readonly type: ClipType = 'html';
 	/**
 	 * Access to the iframe that is required

src/sources/html.ts

@@ -19,4 +19,11 @@ describe('The Image Source Object', () => {
 
 		expect(thumbnail).toBeInstanceOf(Image);
 	});
+
+	it('should accept custom metadata', async () => {
+		const metadata = { a: 1, b: 2 };
+		const source = new ImageSource<typeof metadata>();
+		source.metadata = metadata;
+		expect(source.metadata).toEqual(metadata);
+	});
 });