@miso.ai/client-sdk-ui 1.11.5 → 1.11.6-beta.1

package/src/workflow/autocomplete.js

@@ -107,6 +107,7 @@ export default class Autocomplete extends Workflow {
   }
 
   _updateCompletions(data) {
+    // TODO: session is different
     this._superworkflow.updateCompletions(data);
   }
 

package/src/workflow/base.js

@@ -6,24 +6,6 @@ import { ContainerLayout, ErrorLayout } from '../layout/index.js';
 import { WorkflowOptions, mergeApiOptions, makeConfigurable } from './options/index.js';
 import { getRevision, writeDataStatus, writeMisoIdToMeta, buildBaseInteraction, writeAffiliationInfoToInteraction, mergeInteraction } from './processors.js';
 
-// TODO: just bury this into hub
-function injectLogger(hub, callback) {
-  const { update, trigger } = hub;
-  hub.update = (name, state, options) => {
-    const result = update.call(hub, name, state, options);
-    if (!options || !options.silent) {
-      callback('update', name, state, options);
-    }
-    return result;
-  }
-  hub.trigger = (...args) => {
-    const result = trigger.apply(hub, args);
-    callback('trigger', ...args);
-    return result;
-  }
-  return hub;
-}
-
 const DEFAULT_API_OPTIONS = Object.freeze({});
 
 const DEFAULT_LAYOUTS = Object.freeze({
@@ -62,9 +44,14 @@ export default class Workflow extends Component {
     this._extensions = plugin._getExtensions(client);
     this._defaults = defaults;
     this._options = options || new WorkflowOptions(context && context._options, defaults);
-    this._hub = injectLogger(new Hub(), (...args) => this._log(...args));
+    this._hub = new Hub({
+      onUpdate: event => this._onHubUpdate(event),
+      onEmit: event => this._onHubEmit(event),
+    });
     this._sessionContext = new WeakMap();
 
+    client._events.emit('workflow', this);
+
     this._initProperties(args);
     this._initActors(args);
     this._initSubscriptions(args);
@@ -108,8 +95,25 @@ export default class Workflow extends Component {
     return context;
   }
 
+  // hub //
+  _onHubUpdate(event) {
+    this._runCallbacks(this._client.meta.parent._hubUpdateCallbacks, event);
+  }
+
+  _onHubEmit(event) {
+    this._runCallbacks(this._client.meta.parent._hubEmitCallbacks, event);
+    this._emitAsWorkflowEvent(event);
+  }
+
+  _emitAsWorkflowEvent({ action: _action, name, state, silent }) {
+    if (!silent) {
+      this._emit(name, { _action, ...state });
+    }
+  }
+
   // properties //
   get uuid() {
+    // TODO: review this
     return this.session && this.session.uuid;
   }
 
@@ -319,14 +323,20 @@ export default class Workflow extends Component {
   }
 
   // helper //
-  _log(action, name, data) {
-    this._emit(name, { _action: action, ...data });
+  _runCallbacks(callbacks, event) {
+    for (const callback of callbacks) {
+      try {
+        callback({ workflow: this, ...event });
+      } catch(e) {
+        this._error(e);
+      }
+    }
   }
 
   _emit(name, data) {
-    this._events.emit(name, data);
+    this._events.emit(name, { _event: name, ...data });
     if (this._context) {
-      this._context._events.emit(name, { workflow: this, ...data });
+      this._context._events.emit(name, { workflow: this, _event: name, ...data });
     }
   }
 

package/src/workflow/explore.js

@@ -1,5 +1,5 @@
 import { API } from '@miso.ai/commons';
-import Workflow from './base.js';
+import UnitWorkflow from './unit.js';
 import { fields } from '../actor/index.js';
 import { ROLE, EVENT_TYPE } from '../constants.js';
 import { ListLayout, SearchBoxLayout } from '../layout/index.js';
@@ -7,19 +7,19 @@ import { mergeRolesOptions, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
 import { enableUseLink, UseLinkMixin } from './use-link.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_API_OPTIONS,
+  ...UnitWorkflow.DEFAULT_API_OPTIONS,
   group: API.GROUP.ASK,
   name: API.NAME.RELATED_QUESTIONS,
 });
 
 const DEFAULT_LAYOUTS = Object.freeze({
-  ...Workflow.DEFAULT_LAYOUTS,
+  ...UnitWorkflow.DEFAULT_LAYOUTS,
   [ROLE.RELATED_QUESTIONS]: [ListLayout.type, { itemType: 'question', link: { rel: 'noopener nofollow' } }],
   [ROLE.QUERY]: [SearchBoxLayout.type, { placeholder: 'Ask a question' }],
 });
 
 const DEFAULT_TRACKERS = Object.freeze({
-  ...Workflow.DEFAULT_TRACKERS,
+  ...UnitWorkflow.DEFAULT_TRACKERS,
   [ROLE.RELATED_QUESTIONS]: DEFAULT_TRACKER_OPTIONS,
   [ROLE.CONTAINER]: {
     ...DEFAULT_TRACKER_OPTIONS,
@@ -33,26 +33,26 @@ const DEFAULT_TRACKERS = Object.freeze({
 });
 
 const DEFAULT_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_OPTIONS,
+  ...UnitWorkflow.DEFAULT_OPTIONS,
   api: DEFAULT_API_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS,
 });
 
-const ROLES_OPTIONS = mergeRolesOptions(Workflow.ROLES_OPTIONS, {
+const ROLES_OPTIONS = mergeRolesOptions(UnitWorkflow.ROLES_OPTIONS, {
   main: ROLE.RELATED_QUESTIONS,
   members: Object.keys(DEFAULT_LAYOUTS),
 });
 
-export default class Explore extends Workflow {
+export default class Explore extends UnitWorkflow {
 
-  constructor(plugin, client) {
+  constructor(context, id) {
     super({
       name: 'explore',
-      plugin,
-      client,
+      context,
       roles: ROLES_OPTIONS,
       defaults: DEFAULT_OPTIONS,
+      id,
     });
   }
 
@@ -79,12 +79,13 @@ export default class Explore extends Workflow {
     });
   }
 
-  useApi(options) {
+  useApi(...args) {
+    const options = (typeof args[0] === 'object' ? args[0] : args[1]) || {};
     const { product_id } = options;
     if (product_id) {
       this._productId = product_id;
     }
-    return super.useApi(options);
+    return super.useApi(...args);
   }
 
   useLink(fn, options) {

package/src/workflow/explores.js

@@ -0,0 +1,14 @@
+import UnitWorkflowContext from './units.js';
+import Explore from './explore.js';
+
+export default class Explores extends UnitWorkflowContext {
+
+  constructor(plugin, client) {
+    super('explores', plugin, client);
+  }
+
+  _create(unitId) {
+    return new Explore(this, unitId);
+  }
+
+}

package/src/workflow/hybrid-search-answer.js

@@ -36,7 +36,7 @@ export default class HybridSearchAnswer extends AnswerBasedWorkflow {
     super.restart();
     // cascade restart to the sibling
     const results = this._superworkflow._results;
-    results._views.filters.reset();
+    results._views.filters.reset({ silent: true });
     results.restart();
     this._resultsSession = results.session; // keep track of the session
   }

package/src/workflow/index.js

@@ -1,5 +1,5 @@
 export { default as Asks } from './asks.js';
 export { default as HybridSearch } from './hybrid-search.js';
-export { default as Explore } from './explore.js';
 export { default as Search } from './search.js';
 export { default as Recommendations } from './recommendations.js';
+export { default as Explores } from './explores.js';

package/src/workflow/processors.js

@@ -175,10 +175,10 @@ export function concatItemsFromMoreResponse(oldData, newData, { role = ROLE.PROD
   // use old values of facet_counts and total, for they are affected by product_id exclusion
   return {
     ...newData,
-    facet_counts,
-    total,
     value: {
       ...newData.value,
+      facet_counts,
+      total,
       [role]: [...oldProducts, ...newProducts],
     },
   }

package/src/workflow/recommendation.js

@@ -1,43 +1,42 @@
-import { defineValues, API } from '@miso.ai/commons';
-import Workflow from './base.js';
+import { API } from '@miso.ai/commons';
+import UnitWorkflow from './unit.js';
 import { ListLayout } from '../layout/index.js';
 import { ROLE } from '../constants.js';
 import { mergeRolesOptions, DEFAULT_TRACKER_OPTIONS } from './options/index.js';
-import { mergeInteraction } from './processors.js';
 
 const DEFAULT_API_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_API_OPTIONS,
+  ...UnitWorkflow.DEFAULT_API_OPTIONS,
   group: API.GROUP.RECOMMENDATION,
   name: API.NAME.USER_TO_PRODUCTS,
   payload: {
-    ...Workflow.DEFAULT_API_OPTIONS.payload,
+    ...UnitWorkflow.DEFAULT_API_OPTIONS.payload,
     fl: ['*'],
   },
 });
 
 const DEFAULT_LAYOUTS = Object.freeze({
-  ...Workflow.DEFAULT_LAYOUTS,
+  ...UnitWorkflow.DEFAULT_LAYOUTS,
   [ROLE.PRODUCTS]: ListLayout.type,
 });
 
 const DEFAULT_TRACKERS = Object.freeze({
-  ...Workflow.DEFAULT_TRACKERS,
+  ...UnitWorkflow.DEFAULT_TRACKERS,
   [ROLE.PRODUCTS]: DEFAULT_TRACKER_OPTIONS,
 });
 
 const DEFAULT_OPTIONS = Object.freeze({
-  ...Workflow.DEFAULT_OPTIONS,
+  ...UnitWorkflow.DEFAULT_OPTIONS,
   api: DEFAULT_API_OPTIONS,
   layouts: DEFAULT_LAYOUTS,
   trackers: DEFAULT_TRACKERS,
 });
 
-const ROLES_OPTIONS = mergeRolesOptions(Workflow.ROLES_OPTIONS, {
+const ROLES_OPTIONS = mergeRolesOptions(UnitWorkflow.ROLES_OPTIONS, {
   main: ROLE.PRODUCTS,
   members: Object.keys(DEFAULT_LAYOUTS),
 });
 
-export default class Recommendation extends Workflow {
+export default class Recommendation extends UnitWorkflow {
 
   constructor(context, id) {
     super({
@@ -49,17 +48,6 @@ export default class Recommendation extends Workflow {
     });
   }
 
-  _initProperties(args) {
-    super._initProperties(args);
-    const { id } = args;
-    defineValues(this, { id });
-  }
-
-  _initSession(args) {
-    this._context._members.set(args.id, this);
-    super._initSession(args);
-  }
-
   // lifecycle //
   start() {
     // in recommendation workflow, start() triggers query
@@ -72,30 +60,4 @@ export default class Recommendation extends Workflow {
     return this;
   }
 
-  // interactions //
-  _defaultProcessInteraction(payload, args) {
-    payload = super._defaultProcessInteraction(payload, args);
-    payload = this._writeUnitIdToInteraction(payload, args);
-    return payload;
-  }
-
-  _writeUnitIdToInteraction(payload) {
-    const unit_id = this.id;
-    const unit_instance_uuid = this.uuid;
-    return mergeInteraction(payload, {
-      context: {
-        custom_context: {
-          unit_id,
-          unit_instance_uuid,
-        },
-      },
-    });
-  }
-
-  // destroy //
-  _destroy(options) {
-    this._context._members.delete(this.id);
-    super._destroy(options);
-  }
-
 }

package/src/workflow/recommendations.js

@@ -1,34 +1,14 @@
-import { DEFAULT_UNIT_ID } from '../constants.js';
-import WorkflowContext from './context.js';
+import UnitWorkflowContext from './units.js';
 import Recommendation from './recommendation.js';
 
-export default class Recommendations extends WorkflowContext {
+export default class Recommendations extends UnitWorkflowContext {
 
   constructor(plugin, client) {
     super('recommendations', plugin, client);
-    this._members = new Map();
   }
 
-  workflows() {
-    return [...this._members.values()];
-  }
-
-  create(unitId = DEFAULT_UNIT_ID) {
-    if (this._members.has(unitId)) {
-      throw new Error(`Unit already exists: ${unitId}`);
-    }
+  _create(unitId) {
     return new Recommendation(this, unitId);
   }
 
-  has(unitId = DEFAULT_UNIT_ID) {
-    return this._members.has(unitId);
-  }
-
-  get(unitId = DEFAULT_UNIT_ID) {
-    if (typeof unitId !== 'string') {
-      throw new Error(`Required unit ID to be a string: ${unitId}`);
-    }
-    return this._members.get(unitId) || new Recommendation(this, unitId);
-  }
-
 }

package/src/workflow/search-based.js

@@ -102,6 +102,9 @@ export default class SearchBasedWorkflow extends Workflow {
     // keep track of the query args for refine and more calls
     this._queryArgs = args;
 
+    // reset filters view
+    this._views.filters.reset({ silent: true });
+
     // start a new session
     this.restart();
 
@@ -126,6 +129,7 @@ export default class SearchBasedWorkflow extends Workflow {
     this._request({ payload });
   }
 
+  // TODO: expose API
   _more() {
     // if still loading, complain
     if (this.status !== STATUS.READY) {

package/src/workflow/unit.js

@@ -0,0 +1,52 @@
+import { defineValues } from '@miso.ai/commons';
+import Workflow from './base.js';
+import { mergeInteraction } from './processors.js';
+
+export default class UnitWorkflow extends Workflow {
+
+  _initProperties(args) {
+    super._initProperties(args);
+    const { id } = args;
+    defineValues(this, { id });
+  }
+
+  _initSession(args) {
+    this._context._members.set(args.id, this);
+    super._initSession(args);
+  }
+
+  // interactions //
+  _defaultProcessInteraction(payload, args) {
+    payload = super._defaultProcessInteraction(payload, args);
+    payload = this._writeUnitIdToInteraction(payload, args);
+    return payload;
+  }
+
+  _writeUnitIdToInteraction(payload) {
+    const unit_id = this.id;
+    const unit_instance_uuid = this.uuid;
+    return mergeInteraction(payload, {
+      context: {
+        custom_context: {
+          unit_id,
+          unit_instance_uuid,
+        },
+      },
+    });
+  }
+
+  // destroy //
+  _destroy(options) {
+    this._context._members.delete(this.id);
+    super._destroy(options);
+  }
+
+}
+
+Object.assign(UnitWorkflow, {
+  DEFAULT_API_OPTIONS: Workflow.DEFAULT_API_OPTIONS,
+  DEFAULT_LAYOUTS: Workflow.DEFAULT_LAYOUTS,
+  DEFAULT_TRACKERS: Workflow.DEFAULT_TRACKERS,
+  DEFAULT_OPTIONS: Workflow.DEFAULT_OPTIONS,
+  ROLES_OPTIONS: Workflow.ROLES_OPTIONS,
+});

package/src/workflow/units.js

@@ -0,0 +1,37 @@
+import { DEFAULT_UNIT_ID } from '../constants.js';
+import WorkflowContext from './context.js';
+
+export default class UnitWorkflowContext extends WorkflowContext {
+
+  constructor(name, plugin, client) {
+    super(name, plugin, client);
+    this._members = new Map();
+  }
+
+  workflows() {
+    return [...this._members.values()];
+  }
+
+  create(unitId = DEFAULT_UNIT_ID) {
+    if (this._members.has(unitId)) {
+      throw new Error(`Unit already exists: ${unitId}`);
+    }
+    return this._create(unitId);
+  }
+
+  has(unitId = DEFAULT_UNIT_ID) {
+    return this._members.has(unitId);
+  }
+
+  get(unitId = DEFAULT_UNIT_ID) {
+    if (typeof unitId !== 'string') {
+      throw new Error(`Required unit ID to be a string: ${unitId}`);
+    }
+    return this._members.get(unitId) || this._create(unitId);
+  }
+
+  _create(unitId) {
+    throw new Error('Not implemented');
+  }
+
+}