feat(CMP-5384): Moved content reference from media to content/models

Wanting review on any helper functions a content reference would benefit from, maybe being able to request the reference?

src/index.ts

@@ -4,6 +4,7 @@ export * from './lib/ContentClientConfig';
 export * from './lib/content/model/ContentBody';
 export * from './lib/content/model/ContentItem';
 export * from './lib/content/model/ContentLifecycle';
+export * from './lib/content/model/ContentReference';
 export * from './lib/content/model/ContentMeta';
 export * from './lib/content/model/Edition';
 export * from './lib/content/model/FragmentMeta';
@@ -14,6 +15,5 @@ export * from './lib/media/Image';
 export * from './lib/media/ImageUrlBuilder';
 export * from './lib/media/model/ImageFormat';
 export * from './lib/media/Video';
-export * from './lib/media/ContentReference';
 
 export * from './lib/rendering/model/RenderedContentItem';

src/lib/content/mapper/ContentMapper.spec.ts

@@ -1,10 +1,9 @@
 import { expect } from 'chai';
 import { ContentMapper } from './ContentMapper';
-import { ContentMeta } from '../model/ContentMeta';
+import { ContentMeta, ContentReferenceMeta } from '../model/ContentMeta';
 import { Image } from '../../media/Image';
 import { Video } from '../../media/Video';
-import { ContentReference } from '../../media/ContentReference';
-import { ContentReferenceMeta } from '../../media/MediaMeta';
+import { ContentReference } from '../model/ContentReference';
 
 const config = {
   account: 'test'

src/lib/content/mapper/ContentMapper.ts

@@ -4,7 +4,7 @@ import { ContentMeta } from '../model/ContentMeta';
 import { ContentClientConfig } from '../../ContentClientConfig';
 import { Image } from '../../media/Image';
 import { Video } from '../../media/Video';
-import { ContentReference } from '../../media/ContentReference';
+import { ContentReference } from '../model/ContentReference';
 
 /**
  * @hidden
@@ -113,7 +113,7 @@ export class ContentMapper {
    */
   protected convertContentReference(fragment: any): any {
     if (ContentReference.isContentReference(fragment)) {
-      const result = new ContentReference(fragment, this.config);
+      const result = new ContentReference(fragment);
       return result;
     }
   }

src/lib/content/model/ContentMeta.ts

@@ -2,6 +2,15 @@ import { Edition } from './Edition';
 import { ContentLifecycle } from './ContentLifecycle';
 import { FragmentMeta } from './FragmentMeta';
 
+/**
+ * Class providing meta data about an Content Reference resource.
+ */
+export class ContentReferenceMeta extends FragmentMeta {
+  constructor(data?: any) {
+    super(data);
+  }
+}
+
 /**
  * Class providing meta data about a content item with helper functions.
  */

src/lib/media/ContentReference.spec.ts → src/lib/content/model/ContentReference.spec.ts

@@ -13,7 +13,7 @@ describe('Content Reference', () => {
         name: 'content ref'
       };
 
-      const content = new ContentReference(json, { account: 'test' });
+      const content = new ContentReference(json);
       expect(content.toJSON()).to.deep.eq(json);
     });
 
@@ -28,7 +28,7 @@ describe('Content Reference', () => {
         contentType: 'http://some-content-type.com/type.json'
       };
 
-      const content = new ContentReference(json, { account: 'test' });
+      const content = new ContentReference(json);
       expect(content.toJSON()).to.deep.eq(json);
     });
   });

src/lib/media/ContentReference.ts → src/lib/content/model/ContentReference.ts

@@ -1,13 +1,32 @@
-import { Media } from './Media';
-import { ContentReferenceMeta } from './MediaMeta';
-import { ContentClientConfig } from '../ContentClientConfig';
-import { FragmentMeta } from '../content/model/FragmentMeta';
+import { FragmentMeta } from './FragmentMeta';
+import { ContentReferenceMeta } from './ContentMeta';
 
-export class ContentReference extends Media {
+export type ContentReferenceSchema = 'http://bigcontent.io/cms/schema/v1/core#/definitions/content-reference';
+
+/**
+ * Required params for creating an content reference
+ */
+export type RequriedContentReference<T extends {} = {}> = T & {
+  id: string;
+  name: string;
+  contentType?: string;
+  _meta?: {
+    schema: ContentReferenceSchema;
+  };
+};
+
+/**
+ * Class representing an Content Reference.
+ */
+export class ContentReference {
+
+  id: string;
+  name: string;
   contentType: string;
+  _meta: ContentReferenceMeta;
 
-  constructor(data: any, config: ContentClientConfig) {
-    super(data, config);
+  constructor(data: RequriedContentReference) {
+    Object.assign(this, data);
 
     if (data && data._meta) {
       this._meta = new ContentReferenceMeta(data._meta);
@@ -22,8 +41,11 @@ export class ContentReference extends Media {
    * Export ContentReference to JSON
    */
   toJSON(): any {
-    const json = super.toJSON();
-    const { defaultHost, endpoint, ...result } = json;
+    const { name, id } = this;
+    const result: RequriedContentReference = {
+      id,
+      name
+    };
 
     if (this._meta) {
       result._meta = this._meta.toJSON();

src/lib/media/Media.ts

@@ -1,5 +1,5 @@
 import { ContentClientConfig } from '../ContentClientConfig';
-import { ImageMeta, VideoMeta, ContentReferenceMeta } from './MediaMeta';
+import { ImageMeta, VideoMeta } from './MediaMeta';
 
 /**
  * @hidden
@@ -9,7 +9,7 @@ export abstract class Media {
   /**
    * Metadata about the Media object
    */
-  _meta: ImageMeta | VideoMeta | ContentReferenceMeta;
+  _meta: ImageMeta | VideoMeta;
 
   /**
    * Default host name to use when constructing a URL to the resource.

src/lib/media/MediaMeta.ts

@@ -18,15 +18,6 @@ export class ImageMeta extends MediaMeta {
   }
 }
 
-/**
- * Class providing meta data about an Content Reference resource.
- */
-export class ContentReferenceMeta extends MediaMeta {
-  constructor(data?: any) {
-    super(data);
-  }
-}
-
 /**
  * Class providing meta data about a Video resource.
  */