Skip to content

Add notification triggers support #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bblaisATcoveo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add notification triggers support #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions src/connector.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
buildDidYouMean,
buildContext,
buildInteractiveResult,
buildNotifyTrigger,
loadAdvancedSearchQueryActions,
loadSortCriteriaActions,
HighlightUtils,
Expand Down Expand Up @@ -59,19 +60,22 @@ let querySummaryController;
let didYouMeanController;
let pagerController;
let statusController;
let notifyTriggerController;
let urlManager;
let unsubscribeManager;
let unsubscribeSearchBoxController;
let unsubscribeResultListController;
let unsubscribeQuerySummaryController;
let unsubscribeDidYouMeanController;
let unsubscribePagerController;
let unsubscribeNotifyTriggerController;

// UI states
let updateSearchBoxFromState = false;
let searchBoxState;
let resultListState;
let querySummaryState;
let notificationState;
let didYouMeanState;
let pagerState;
let lastCharKeyUp;
Expand All @@ -89,6 +93,7 @@ let formElement = document.querySelector( `.page-type-search main [role=search],
let resultsSection = document.querySelector( `#${resultSectionID}` );
let resultListElement = document.querySelector( '#result-list' );
let querySummaryElement = document.querySelector( '#query-summary' );
let notificationTriggerElement = document.querySelector( '#notification-trigger' );
let pagerElement = document.querySelector( '#pager' );
let suggestionsElement = document.querySelector( '#suggestions' );
let didYouMeanElement = document.querySelector( '#did-you-mean' );
Expand All @@ -97,6 +102,7 @@ let didYouMeanElement = document.querySelector( '#did-you-mean' );
let resultTemplateHTML = document.getElementById( 'sr-single' )?.innerHTML;
let noResultTemplateHTML = document.getElementById( 'sr-nores' )?.innerHTML;
let resultErrorTemplateHTML = document.getElementById( 'sr-error' )?.innerHTML;
let notificationTriggerTemplateHTML = document.getElementById( 'sr-notification-trigger' )?.innerHTML;
let querySummaryTemplateHTML = document.getElementById( 'sr-query-summary' )?.innerHTML;
let didYouMeanTemplateHTML = document.getElementById( 'sr-did-you-mean' )?.innerHTML;
let noQuerySummaryTemplateHTML = document.getElementById( 'sr-noquery-summary' )?.innerHTML;
Expand Down Expand Up @@ -264,6 +270,17 @@ function initTpl() {
}
}

if ( !notificationTriggerTemplateHTML ) {
if ( lang === "fr" ) {
notificationTriggerTemplateHTML =
`<section class="alert alert-info">%[notification]</section>`;
}
else {
notificationTriggerTemplateHTML =
`<section class="alert alert-info">%[notification]</section>`;
}
}

if ( !querySummaryTemplateHTML ) {
if ( lang === "fr" ) {
querySummaryTemplateHTML =
Expand Down Expand Up @@ -366,6 +383,14 @@ function initTpl() {
resultsSection.id = resultSectionID;
}

// auto-create notification trigger element
if ( !notificationTriggerElement ) {
notificationTriggerElement = document.createElement( "div" );
notificationTriggerElement.id = "notification-trigger";

resultsSection.append( notificationTriggerElement );
}

// auto-create query summary element
if ( !querySummaryElement ) {
querySummaryElement = document.createElement( "div" );
Expand Down Expand Up @@ -658,6 +683,7 @@ function initEngine() {
didYouMeanController = buildDidYouMean( headlessEngine, { options: { automaticallyCorrectQuery: params.automaticallyCorrectQuery } } );
pagerController = buildPager( headlessEngine, { options: { numberOfPages: params.numberOfPages } } );
statusController = buildSearchStatus( headlessEngine );
notifyTriggerController = buildNotifyTrigger( headlessEngine );

// Refine search based on URL parameters for filters, mostly used in Advanced Search to trigger only one search per page load
if ( urlParams.allq || urlParams.exctq || urlParams.anyq || urlParams.noneq || urlParams.fqupdate || urlParams.dmn || urlParams.fqocct || urlParams.elctn_cat || urlParams.filetype || urlParams.site || urlParams.year || urlParams.declaredtype || urlParams.startdate || urlParams.enddate || urlParams.dprtmnt ) {
Expand Down Expand Up @@ -892,6 +918,7 @@ function initEngine() {
unsubscribeQuerySummaryController = querySummaryController.subscribe( () => updateQuerySummaryState( querySummaryController.state ) );
unsubscribeDidYouMeanController = didYouMeanController.subscribe( () => updateDidYouMeanState( didYouMeanController.state ) );
unsubscribePagerController = pagerController.subscribe( () => updatePagerState( pagerController.state ) );
unsubscribeNotifyTriggerController = notifyTriggerController.subscribe( () => updateNotifyTriggerState( notifyTriggerController.state ) );

// Clear event tracking, for legacy browsers
const onUnload = () => {
Expand All @@ -902,6 +929,7 @@ function initEngine() {
unsubscribeQuerySummaryController?.();
unsubscribeDidYouMeanController?.();
unsubscribePagerController?.();
unsubscribeNotifyTriggerController?.();
};

// Listen to URL change (hash)
Expand Down Expand Up @@ -1250,6 +1278,18 @@ function updateResultListState( newState ) {
}
}

// Update notification displayed
function updateNotifyTriggerState ( newState ) {
notificationState = newState;

if ( notificationState.notifications?.length ) {
notificationTriggerElement.innerHTML = notificationTriggerTemplateHTML.replace( DOMPurify.sanitize( "%[notification]" ), notificationState.notifications[0] );
}
else {
notificationTriggerElement.textContent = "";
}
}

// Update heading that has number of results displayed (Query Summary)
function updateQuerySummaryState( newState ) {
querySummaryState = newState;
Expand Down