@imposium-hub/components 2.11.3 → 2.11.5-0

package/src/components/publish-wizard/publish/CrMPublishPreviewCell.tsx

@@ -0,0 +1,27 @@
+import * as React from 'react';
+import { Button } from '../../..';
+import { ICON_EYE } from '../../../constants/icons';
+
+interface ICrMPublishPreviewCellProps {
+    cell: any;
+    crmBaseUrl: string;
+    creativeLibraryId: string;
+}
+
+export const CrMPublishPreviewCell: React.FC<ICrMPublishPreviewCellProps> = (props) => {
+    const { cell, crmBaseUrl, creativeLibraryId } = props;
+    const creativeId = cell.row.original.creativeId;
+    const previewUrl = `${crmBaseUrl}/library/${creativeLibraryId}/creative/${creativeId}/versions/`;
+
+    return (
+        <a
+            href={previewUrl}
+            target='_blank'>
+            <Button
+                style='subtle'
+                size='small'>
+                {ICON_EYE}
+            </Button>
+        </a>
+    );
+};

package/src/components/publish-wizard/publish/CrMPublishStatusCell.tsx

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { CREATIVE_STATUS_LABELS } from '../../../constants/publish';
+
+interface ICrMPublishStatusCellProps {
+    cell: any;
+}
+
+export const CrMPublishStatusCell: React.FC<ICrMPublishStatusCellProps> = (props) => {
+    const { cell } = props;
+    return (
+        CREATIVE_STATUS_LABELS[cell.row.original.approvalStatus] || cell.row.original.approvalStatus
+    );
+};

package/src/components/publish-wizard/publish/CrMPublishUI.tsx

@@ -0,0 +1,195 @@
+import * as React from 'react';
+import * as copy from '../../../constants/copy';
+import { DataTable, HRule, Button, IImposiumAPI, TextField } from '../../..';
+import { useEffect, useState, useCallback } from 'react';
+import { ICON_SEARCH } from '../../../constants/icons';
+import { CREATIVE_STATUSES_TO_PUBLISH } from '../../../constants/publish';
+import { CrMPublishStatusCell } from './CrMPublishStatusCell';
+import { CrMPublishPreviewCell } from './CrMPublishPreviewCell';
+import { CrMPublishNameCell } from './CrMPublishNameCell';
+import { CrMPublishCreativeSelectHeader } from './CrMPublishCreativeSelectHeader';
+import { CrMPublishCreativeSelectCell } from './CrMPublishCreativeSelectCell';
+
+interface ICrmPublishUIProps {
+    publishing: boolean;
+    error: React.ReactNode;
+    api: IImposiumAPI;
+    creativeLibraryId: string;
+    projectId: string;
+    crmBaseUrl: string;
+    selectedCreatives: string[];
+    onUpdateSelectedCreatives: (selectedCreatives) => void;
+    onError: (error: string) => void;
+}
+
+export const CrMPublishUI: React.FC<ICrmPublishUIProps> = (props) => {
+    const {
+        publishing,
+        error,
+        crmBaseUrl,
+        creativeLibraryId,
+        projectId,
+        api,
+        selectedCreatives,
+        onUpdateSelectedCreatives
+    } = props;
+    const [nameFilter, setNameFilter] = useState('');
+    const [creativeConfig, setCreativeConfig] = useState([]);
+
+    const nameSearch = (
+        <TextField
+            className='creative-name'
+            buttons={[
+                <Button
+                    key='btn-search'
+                    style='subtle'
+                    size='small'>
+                    {ICON_SEARCH}
+                </Button>
+            ]}
+            width='150px'
+            value={nameFilter}
+            onChange={(value) => setNameFilter(value)}
+        />
+    );
+
+    const onSelectChange = useCallback(
+        (creativeId: string, selected: boolean) => {
+            const previouslySelected = [...selectedCreatives];
+            if (selected) {
+                onUpdateSelectedCreatives([...previouslySelected, creativeId]);
+            } else {
+                onUpdateSelectedCreatives(previouslySelected.filter((id) => id !== creativeId));
+            }
+        },
+        [selectedCreatives, onUpdateSelectedCreatives]
+    );
+
+    const onSelectAllChange = useCallback(
+        (selected: boolean) => {
+            if (selected) {
+                const publishableCreativeIds = creativeConfig
+                    .filter((creative) => canBePublishedTo(creative.approvalStatus))
+                    .map((creative) => creative.creativeId);
+                onUpdateSelectedCreatives(publishableCreativeIds);
+            } else {
+                onUpdateSelectedCreatives([]);
+            }
+        },
+        [nameFilter, creativeConfig]
+    );
+
+    const COLUMN_CONFIG = [
+        {
+            accessor: 'selected',
+            width: 25,
+            disableResize: true,
+            disableSortBy: true,
+            Header: () => (
+                <CrMPublishCreativeSelectHeader
+                    onSelectChange={onSelectAllChange}
+                    selectedCreatives={selectedCreatives}
+                    creativeConfig={creativeConfig}
+                />
+            ),
+            Cell: (cell: any) => (
+                <CrMPublishCreativeSelectCell
+                    cell={cell}
+                    onSelectChange={onSelectChange}
+                    selectedCreatives={selectedCreatives}
+                />
+            )
+        },
+        {
+            accessor: 'creativeName',
+            Header: 'Creative Name',
+            width: 250,
+            minWidth: 250,
+            maxWidth: 250,
+            disableSortBy: true,
+            Cell: (cell: any) => <CrMPublishNameCell cell={cell} />,
+            Search: nameSearch
+        },
+        {
+            accessor: 'creativeId',
+            Header: 'ID',
+            width: 75,
+            minWidth: 75,
+            maxWidth: 75,
+            disableSortBy: true
+        },
+        {
+            accessor: 'numberOfVersions',
+            Header: 'Versions',
+            width: 75,
+            minWidth: 75,
+            maxWidth: 75,
+            disableSortBy: true
+        },
+        {
+            accessor: 'approvalStatus',
+            Header: 'Status',
+            width: 75,
+            minWidth: 75,
+            maxWidth: 75,
+            disableSortBy: true,
+            Cell: (cell: any) => <CrMPublishStatusCell cell={cell} />
+        },
+        {
+            accessor: 'preview',
+            Header: 'Preview',
+            width: 50,
+            minWidth: 50,
+            maxWidth: 50,
+            disableSortBy: true,
+            Cell: (cell: any) => (
+                <CrMPublishPreviewCell
+                    cell={cell}
+                    crmBaseUrl={crmBaseUrl}
+                    creativeLibraryId={creativeLibraryId}
+                />
+            )
+        }
+    ];
+
+    useEffect(() => {
+        api.getCreativesLinkedToProject(projectId)
+            .then((res) => {
+                setCreativeConfig(res.creatives);
+            })
+            .catch((err) => {
+                const msg = err.response?.data?.error || err.message;
+                const errorCopy = copy.publish.errorGettingCreatives.replace('{{ERR}}', msg);
+                props.onError(errorCopy);
+            });
+    }, []);
+
+    return (
+        <div>
+            <h2>{copy.publish.publishStepTitleFromCrM}</h2>
+            <HRule />
+            <p>{publishing ? copy.publish.publishInProgress : ''}</p>
+            <DataTable
+                showInterstitial={publishing}
+                columns={COLUMN_CONFIG}
+                data={
+                    nameFilter
+                        ? creativeConfig.filter((creative) => {
+                              return creative.creativeName
+                                  .toLowerCase()
+                                  .includes(nameFilter.toLowerCase());
+                          })
+                        : creativeConfig
+                }
+                hidePaginator={true}
+                itemsPerPage={1000}
+                tightRows={true}
+            />
+            {error && <p className='publish-error'>{error}</p>}
+        </div>
+    );
+};
+
+export const canBePublishedTo = (approvalStatus: string) => {
+    return CREATIVE_STATUSES_TO_PUBLISH.includes(approvalStatus);
+};

package/src/constants/copy.ts

@@ -127,6 +127,8 @@ export const compositions = {
 };
 
 export const publish = {
+    errorGettingCreatives: 'Error getting creatives linked to project: {{ERR}}',
+    disabledCreativeTooltip: 'You cannot publish a project to a creative with Approved status.',
     uploadAsAssets: 'Upload as Assets',
     noVariablesError:
         'No variables found on the project. Cannot proceed with publishing to Creative Manager until at least one variable is added to the project.',
@@ -147,6 +149,7 @@ export const publish = {
 
     // publish
     publishStepTitle: 'STEP 1: Publish your Project',
+    publishStepTitleFromCrM: 'STEP 1: Publish your Project to selected Creatives',
     publishStepDesc:
         "Your project needs to be published before your changes can be seen. If you haven't made any changes since the last time you published, you can skip to the next step.",
 

package/src/constants/icons.tsx

@@ -60,6 +60,7 @@ import { faJs } from '@fortawesome/free-brands-svg-icons/faJs';
 import { faDownload } from '@fortawesome/free-solid-svg-icons/faDownload';
 import { faUpload } from '@fortawesome/free-solid-svg-icons/faUpload';
 import { faCode } from '@fortawesome/free-solid-svg-icons/faCode';
+import { faEye } from '@fortawesome/free-solid-svg-icons/faEye';
 import {
     faArrowDown,
     faArrowLeft,
@@ -232,3 +233,5 @@ export const ICON_FILE_ERROR = <FontAwesomeIcon icon={faCircleExclamation} />;
 export const ICON_FILE_ADD = <FontAwesomeIcon icon={faFileCirclePlus} />;
 
 export const ICON_FILE_REPLACE = <FontAwesomeIcon icon={faFilePen} />;
+
+export const ICON_EYE = <FontAwesomeIcon icon={faEye} />;

package/src/constants/publish.ts

@@ -27,3 +27,31 @@ export const CRM_PLACEMENT_VARS = [
 export const ADSTUDIO_POST_RENDER_ACTION = 'crm-adstudio';
 
 export const ASSETS_POST_RENDER_ACTION = 'crm-asset';
+
+export const CREATIVE_STATUSES = {
+    PENDING_APPROVAL: 'PENDING_APPROVAL',
+    UNSUBMITTED: 'UNSUBMITTED',
+    PRODUCTION_INCOMPLETE: 'PRODUCTION_INCOMPLETE',
+    APPROVED: 'APPROVED',
+    REJECTED: 'REJECTED',
+    TRANSCODING: 'TRANSCODING',
+    TRANSCODING_ERROR: 'TRANSCODING_ERROR',
+    SUBMITTED: 'SUBMITTED'
+};
+
+export const CREATIVE_STATUS_LABELS = {
+    PENDING_APPROVAL: 'Pending Approval',
+    UNSUBMITTED: 'Production',
+    PRODUCTION_INCOMPLETE: 'Production',
+    APPROVED: 'Approved',
+    REJECTED: 'Rejected',
+    TRANSCODING: 'Transcoding',
+    TRANSCODING_ERROR: 'Transcoding Error',
+    SUBMITTED: 'Submitted'
+};
+
+export const CREATIVE_STATUSES_TO_PUBLISH = [
+    CREATIVE_STATUSES.UNSUBMITTED,
+    CREATIVE_STATUSES.PRODUCTION_INCOMPLETE,
+    CREATIVE_STATUSES.REJECTED
+];

package/src/redux/actions/publish.ts

@@ -74,10 +74,10 @@ export const cancelPublish = (api: IImposiumAPI, storyId: string) => {
     };
 };
 
-export const publishVersion = (api: IImposiumAPI, storyId: string) => {
+export const publishVersion = (api: IImposiumAPI, storyId: string, creativeIds?: string[]) => {
     return (dispatch) => {
         return new Promise((resolve, reject) => {
-            api.runPublish(storyId, '')
+            api.runPublish(storyId, '', creativeIds)
                 .then((d) => {
                     dispatch(getStoryPublishStatus(api, storyId))
                         .then()

package/src/services/API.ts

@@ -14,6 +14,7 @@ import { API_AUTH_TYPES } from '../components/font-picker/font-manager/constants
 export interface IImposiumAPI {
     init(baseUrl: string, credentials: any, orgId?: string);
     updateProjectVersion(storyId: string);
+    getQrCodeDesigns(storyId: string): Promise<any | Error>;
     getAssets(filters: any, storyId: string, unprocessed?: boolean, showVariables?: boolean);
     getAssetItem(assetId: string);
     uploadAsset(
@@ -51,6 +52,7 @@ export interface IImposiumAPI {
     revertVersion(storyId: string, versionId: string);
     getStoryVersions(storyId: string);
     getStoryQRDesigns(creativeLibraryId: string): Promise<any | Error>;
+    getCreativesLinkedToProject(projectId: string): Promise<any | Error>;
     processStoryFile(storyId: string, file_key?: string, url?: string);
     getExperiences(storyId: string, params: any);
     createExperience(
@@ -112,7 +114,7 @@ export interface IImposiumAPI {
     runCut(storyId: string, actId: string, sceneId: string, cutId: string);
     runReRenderCuts(storyId: string, actId: string, sceneId: string);
     runProcessBaseVideo(storyId: string, fileKey: string);
-    runPublish(storyId: string, message: string);
+    runPublish(storyId: string, message: string, creativeIds?: string[]);
     cancelPublish(storyId: string);
     cancelJobPolling();
     getAccssCredentials();
@@ -270,6 +272,13 @@ export default class API {
         });
     };
 
+    public getQrCodeDesigns = (storyId: string): Promise<any | Error> => {
+        return this.doRequest({
+            method: 'GET',
+            url: `/story/${storyId}/creative-library/qr-code-designs`
+        });
+    };
+
     public saveQueueAssoc = (
         queueId: string,
         storyId: string,
@@ -718,6 +727,13 @@ export default class API {
         });
     };
 
+    public getCreativesLinkedToProject = (projectId: string): Promise<any | Error> => {
+        return this.doRequest({
+            method: 'GET',
+            url: `/story/${projectId}/creative-library/creatives`
+        });
+    };
+
     public getExperiences = (storyId: string, params: any): Promise<any | Error> => {
         return this.doRequest({
             method: 'GET',
@@ -1019,14 +1035,22 @@ export default class API {
         });
     };
 
-    public runPublish = (storyId: string, message: string): Promise<any | Error> => {
+    public runPublish = (
+        storyId: string,
+        message: string,
+        creativeIds?: string[]
+    ): Promise<any | Error> => {
         const route = `/job/publish`;
 
-        const jobConfig = {
+        const jobConfig: any = {
             story_id: storyId,
             message
         };
 
+        if (creativeIds) {
+            jobConfig.creative_ids = creativeIds;
+        }
+
         return this.doRequest({
             method: 'POST',
             url: route,