feat: adds hub.related.contentItems.getByDeliveryKey() to lookup a content-item by its delivery key

Author: easen-amp

src/lib/DynamicContent.mocks.ts

@@ -188,6 +188,11 @@ export const HUB = {
       href:
         'https://api.amplience.net/v2/content/hubs/5b32377e4cedfd01c45036d8/snapshots/batch',
     },
+    'delivery-keys': {
+      href:
+        'https://api.amplience.net/v2/content/hubs/5b32377e4cedfd01c45036d8/delivery-keys?key={key}',
+      templated: true,
+    },
   },
 };
 
@@ -303,6 +308,20 @@ export const CONTENT_ITEM = {
 export const CONTENT_ITEM_V2 = { ...CONTENT_ITEM };
 CONTENT_ITEM_V2.version++;
 
+/**
+ * @hidden
+ */
+export const CONTENT_ITEM_WITH_DELIVERY_KEY = {
+  ...CONTENT_ITEM,
+  body: {
+    _meta: {
+      name: 'main-banner',
+      schema: 'http://deliver.bigcontent.io/schema/nested/nested-type.json',
+      deliveryKey: 'a-delivery-key',
+    },
+  },
+};
+
 /**
  * @hidden
  */
@@ -2655,12 +2674,18 @@ export class DynamicContentFixtures {
         CONTENT_ITEMS_FACET
       )
       .nestedCreateResource('batch-create-snapshots', {}, SNAPSHOT_RESULTS);
+
     hubMockResource.mocks.collection(
       `${hubMockResource.resource._links['self'].href}/content-repositories/search/findByFeaturesContaining?feature=slots`,
       'content-repositories',
       [CONTENT_REPOSITORY_SLOTS]
     );
 
+    hubMockResource.mocks.resource(
+      CONTENT_ITEM_WITH_DELIVERY_KEY,
+      `${hubMockResource.resource._links['self'].href}/delivery-keys/content-item?key=a-delivery-key`
+    );
+
     // Content items
     mocks
       .resource(CONTENT_ITEM)

src/lib/model/Hub.spec.ts

@@ -115,6 +115,15 @@ test('facet the content items ', async (t) => {
   );
 });
 
+test('get content item by its deliveryKey', async (t) => {
+  const client = new MockDynamicContent();
+  const hub = await client.hubs.get('5b32377e4cedfd01c45036d8');
+  const result = await hub.related.contentItems.getByDeliveryKey(
+    'a-delivery-key'
+  );
+  t.is(result.body._meta.deliveryKey, 'a-delivery-key');
+});
+
 test('list events', async (t) => {
   const client = new MockDynamicContent();
   const hub = await client.hubs.get('5b32377e4cedfd01c45036d8');

src/lib/model/Hub.ts

@@ -1,5 +1,9 @@
 import { HalResource } from '../hal/models/HalResource';
-import { ContentItemsFacets, FacetedContentItem } from './ContentItem';
+import {
+  ContentItem,
+  ContentItemsFacets,
+  FacetedContentItem,
+} from './ContentItem';
 import {
   ContentRepositoriesPage,
   ContentRepository,
@@ -178,6 +182,12 @@ export class Hub extends HalResource {
           facetQuery,
           ContentItemsFacets
         ),
+
+      getByDeliveryKey: (key: string): Promise<ContentItem> =>
+        this.client.fetchResource(
+          `hubs/${this.id}/delivery-keys/content-item?key=${key}`,
+          ContentItem
+        ),
     },
 
     editions: {