feat(content-item): allow workflow state facet

Author: Benj0s

docs/CONTENT-ITEM.md

@@ -83,6 +83,7 @@ The content item export, copy, move, archive and unarchive commands allow the us
 - `schema`: Filter on schema ids. Example: `--facet schema:http://example.com/schema.json`
 - `locale`: Filter on content item locale. Example: `--facet locale:en-GB`
 - `lastModifiedDate`: Filter on last modified date. Example: `--facet "lastModifiedDate:Last 7 days"`
+- `workflowState`: Filter on workflow state (by workflow state ID). Example: `--facet "workflowState:655f5832db7a1637df1984eb"`
 
 Multiple facets can be applied at once when separated by a comma. Example:
 `--facet "schema:http://example.com/schema.json, name:/name regex/"`

src/common/filter/facet.spec.ts

@@ -242,6 +242,18 @@ describe('facet', () => {
       const itemsStatus = [new ContentItem({ status: 'ACTIVE' }), new ContentItem({ status: 'ARCHIVED' })];
       expect(applyFacet(itemsStatus, { status: 'ARCHIVED' })).toEqual([itemsStatus[1]]);
 
+      const itemsWorkflowState = [
+        Object.assign(new ContentItem({ label: 'draft', workflow: { state: '655f583334f8833c81af64d1' } }), {
+          workflowState: '655f583334f8833c81af64d1'
+        }),
+        Object.assign(new ContentItem({ label: 'published', workflow: { state: '655f5832db7a1637df1984eb' } }), {
+          workflowState: '655f5832db7a1637df1984eb'
+        })
+      ];
+      expect(applyFacet(itemsWorkflowState, { workflowState: '655f5832db7a1637df1984eb' })).toEqual([
+        itemsWorkflowState[1]
+      ]);
+
       const itemsDate = [
         new ContentItem({ lastModifiedDate: fakeDateM1 }),
         new ContentItem({ lastModifiedDate: fakeDateM10 })

src/common/filter/facet.ts

@@ -13,6 +13,7 @@ export interface Facet {
   schema?: string;
   status?: string;
   lastModifiedDate?: FacetRange | DatePreset;
+  workflowState?: string;
 }
 
 export type DatePreset = 'Last 7 days' | 'Last 14 days' | 'Last 30 days' | 'Last 60 days' | 'Over 60 days';
@@ -188,6 +189,8 @@ export function applyFacet(items: ContentItem[], facetOrString: Facet | string):
     )
       return false;
     if (facet.status && !equalsOrRegex(item.status, facet.status)) return false;
+    if (facet.workflowState && (!item.workflow || !equalsOrRegex(item.workflow.state, facet.workflowState)))
+      return false;
 
     // Date range checks.
     if (facet.lastModifiedDate && !dateRangeMatch(item.lastModifiedDate, facet.lastModifiedDate)) return false;

src/common/filter/fetch-content.spec.ts

@@ -357,6 +357,39 @@ describe('fetch-content', () => {
       expect(facetContentModule.shouldFacetEnriched).not.toHaveBeenCalled();
     });
 
+    it('should add workflow state to field if an exact match array can be extracted', async () => {
+      const client = await dynamicContentClientFactory(config);
+      const hub = new Hub({});
+      const item1 = new ContentItem({ label: 'item1' });
+      hub.related.contentItems.facet = jest.fn().mockResolvedValue(new MockPage(ContentItem, [item1]));
+      jest.spyOn(facetContentModule, 'shouldFacetEnriched').mockResolvedValue(true);
+
+      const facet = {
+        workflowState: '/^655f583334f8833c81af64d1$|^655f5832db7a1637df1984eb$/'
+      };
+
+      expect(await facetContentModule.tryFetchContent(client, hub, facet, params)).toEqual([item1]);
+
+      expect(hub.related.contentItems.facet).toHaveBeenCalledWith(
+        {
+          fields: [
+            {
+              facetAs: 'ENUM',
+              field: 'workflow.state',
+              filter: {
+                type: 'IN',
+                values: ['655f583334f8833c81af64d1', '655f5832db7a1637df1984eb']
+              }
+            }
+          ],
+          returnEntities: true
+        },
+        { query: 'contentRepositoryId:"repo"folderId:"folder"', size: expect.any(Number) }
+      );
+      expect(client.contentItems.get).not.toHaveBeenCalled();
+      expect(facetContentModule.shouldFacetEnriched).not.toHaveBeenCalled();
+    });
+
     it('should prefer status from params to the one in the facet object', async () => {
       const client = await dynamicContentClientFactory(config);
       const hub = new Hub({});

src/common/filter/fetch-content.ts

@@ -128,6 +128,18 @@ export const tryFetchContent = async (
     });
   }
 
+  const workflowStateArray = tryGetArray(facet.workflowState, true);
+  if (workflowStateArray) {
+    facetQuery.fields.push({
+      facetAs: 'ENUM',
+      field: 'workflow.state',
+      filter: {
+        type: 'IN',
+        values: workflowStateArray
+      }
+    });
+  }
+
   if (facet.name) {
     const names = tryGetArray(facet.name, false);