@miso.ai/client-sdk-core 1.8.0-beta.9 → 1.8.1-beta.0

package/{dist/es → src}/plugin/auto-events.js

@@ -1,44 +1,44 @@
 import { Component } from '@miso.ai/commons';
+import { constants as API } from '../api/index.js';
+
 const PLUGIN_ID = 'std:auto-events';
+
 export default class AutoEventsPlugin extends Component {
+
   static get id() {
     return PLUGIN_ID;
   }
+
   constructor() {
     super('auto-events');
     this._contexts = new WeakMap();
   }
+
   install(MisoClient, context) {
     context.addSubtree(this);
     MisoClient.on('create', this._injectClient.bind(this));
     context.addPayloadPass(this._captureApiRequest.bind(this));
   }
+
   _injectClient(client) {
     const context = new AutoEventsContext(this);
     this._contexts.set(client, context);
     client.autoEvents = context.interface;
   }
-  _captureApiRequest(_ref) {
-    let {
-      client,
-      apiGroup,
-      apiName,
-      payload
-    } = _ref;
+
+  _captureApiRequest({ client, apiGroup, apiName, payload }) {
     switch (apiGroup) {
-      case 'search':
+      case API.GROUP.SEARCH:
         switch (apiName) {
-          case 'search':
+          case API.NAME.SEARCH:
             this._captureSearchApiRequest(client, payload);
             break;
         }
         break;
     }
   }
-  _captureSearchApiRequest(client, _ref2) {
-    let {
-      q: keywords
-    } = _ref2;
+
+  _captureSearchApiRequest(client, { q: keywords }) {
     if (!keywords || keywords === '*') {
       // might be a facet search without real keywords
       return;
@@ -49,29 +49,26 @@ export default class AutoEventsPlugin extends Component {
     }
     client.api.interactions.upload({
       type: 'search',
-      search: {
-        keywords
-      },
-      context: {
-        custom_context: {
-          channel: 'miso_api'
-        }
-      }
+      search: { keywords },
+      context: { custom_context: { channel: 'miso_api' } },
     });
   }
+
 }
+
 class AutoEventsContext {
+
   constructor(plugin) {
     this._plugin = plugin;
     this._config = {
-      search: true
+      search: true,
     };
     this.interface = Object.freeze({
-      config: this.config.bind(this)
+      config: this.config.bind(this),
     });
   }
-  config() {
-    let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+
+  config(options = {}) {
     if (typeof options !== 'object') {
       throw new Error(`Config options must be an object or undefined: ${options}`);
     }
@@ -86,6 +83,9 @@ class AutoEventsContext {
         this._plugin._events.emit('config', `${key}: ${oldValue} -> ${newValue}`);
       }
     }
-    return Object.freeze(Object.assign({}, this._config));
+    return Object.freeze({
+      ...this._config,
+    });
   }
-}
+
+}

package/src/plugin/index.js

@@ -0,0 +1,3 @@
+export { default as UserPlugin } from './user.js';
+export { default as PageInfoPlugin } from './page-info.js';
+export { default as AutoEventsPlugin } from './auto-events.js';

package/{dist/es → src}/plugin/page-info.js

@@ -1,49 +1,53 @@
 import { trimObj } from '@miso.ai/commons';
+
 const ID = 'std:page-info';
+
 export default class PageInfoPlugin {
+
   static get id() {
     return ID;
   }
-  constructor() {}
-  install(_, _ref) {
-    let {
-      addPayloadPass
-    } = _ref;
+
+  constructor() {
+  }
+
+  install(_, { addPayloadPass }) {
     addPayloadPass(this._modifyPayload.bind(this));
   }
-  _modifyPayload(_ref2) {
-    let {
-      apiGroup,
-      apiName,
-      payload
-    } = _ref2;
-    return apiGroup === 'interactions' && apiName === 'upload' ? this._modifyPayloadForInteractions(payload) : payload;
+
+  _modifyPayload({ apiGroup, apiName, payload }) {
+    return apiGroup === 'interactions' && apiName === 'upload' ?
+      this._modifyPayloadForInteractions(payload) : payload;
   }
-  _modifyPayloadForInteractions(_ref3) {
-    let {
-      data
-    } = _ref3;
-    data = data.map(obj => Object.assign({}, obj, {
-      context: Object.assign({}, getPayloadContext(), obj.context)
+
+  _modifyPayloadForInteractions({ data }) {
+    data = data.map(obj => ({
+      ...obj,
+      context: {
+        ...getPayloadContext(),
+        ...obj.context,
+      },
     }));
-    return {
-      data
-    };
+    return { data };
   }
+
 }
+
 function getPayloadContext() {
   return trimObj({
     page: readPageInfo(),
     campaign: readUtm()
   });
 }
+
 function readPageInfo() {
   return trimObj({
     url: window.location.href,
     referrer: document.referrer,
-    title: document.title
+    title: document.title,
   });
 }
+
 function readUtm() {
   const params = new URLSearchParams(window.location.search);
   let utm = trimObj({
@@ -51,7 +55,7 @@ function readUtm() {
     medium: params.get('utm_medium') || undefined,
     name: params.get('utm_campaign') || undefined,
     term: params.get('utm_term') || undefined,
-    content: params.get('utm_content') || undefined
+    content: params.get('utm_content') || undefined,
   });
   return Object.keys(utm).length === 0 ? undefined : utm;
-}
+}

package/{dist/es → src}/plugin/plugin-root.js

@@ -1,12 +1,14 @@
-import { delegateGetters, defineValues, Registry, Resolution, Resources, uuidv4 } from '@miso.ai/commons';
-import classes from '../classes';
-import AnonymousPlugin from './anonymous';
-import { getPluginScriptUrl } from './urls';
+import { delegateGetters, defineValues, Registry, Resolution, Resources } from '@miso.ai/commons';
+import classes from '../classes.js';
+import AnonymousPlugin from './anonymous.js';
+import { getPluginScriptUrl } from './urls.js';
+
 export default class PluginRoot extends Registry {
+
   constructor(root) {
     super('plugins', root, {
       libName: 'plugin class',
-      keyName: 'id'
+      keyName: 'id',
     });
     this._root = root;
     this._currentScript = document.currentScript;
@@ -18,16 +20,20 @@ export default class PluginRoot extends Registry {
     this.context = new PluginContext(this, classes);
     this.plugins = new Plugins(this);
   }
+
   isInstalled(id) {
     this._checkKey(id);
     return !!this._installed[id];
   }
+
   get installed() {
     return Object.values(this._installed);
   }
+
   get(id) {
     return this._installed[id];
   }
+
   getPluginClass(id) {
     return this._libraries[id];
   }
@@ -56,6 +62,7 @@ export default class PluginRoot extends Registry {
     instance = this._instantiate(plugin, options);
     this._install(instance);
   }
+
   async install(plugin, options) {
     this.use(plugin, options);
     if (typeof plugin === 'string' && !this.isRegistered(plugin)) {
@@ -63,31 +70,44 @@ export default class PluginRoot extends Registry {
     }
     return this.whenInstalled(plugin);
   }
+
   async whenInstalled(id) {
+    if (typeof id === 'function' && id.id && typeof id.id === 'string') {
+      id = id.id;
+    }
     if (this.isInstalled(id)) {
       return this.get(id);
     }
-    const {
-      promise
-    } = this._installedResolutions[id] || (this._installedResolutions[id] = new Resolution());
+    const { promise } = this._installedResolutions[id] || (this._installedResolutions[id] = new Resolution());
     return promise;
   }
+
   addSubtree(component) {
     this._subtrees.push(component);
     this._events.emit('subtree', component);
   }
+
   addPayloadPass(pass) {
     if (typeof pass !== 'function') {
       throw new Error(`Expect parameter to be a function: ${pass}`);
     }
     this._root._payloadPasses.push(pass);
   }
+
   addUrlPass(pass) {
     if (typeof pass !== 'function') {
       throw new Error(`Expect parameter to be a function: ${pass}`);
     }
     this._root._urlPasses.push(pass);
   }
+
+  setCustomFetch(fetch) {
+    if (typeof fetch !== 'function') {
+      throw new Error(`Expect parameter to be a function: ${fetch}`);
+    }
+    this._root._customFetch = fetch;
+  }
+
   _tryConfig(instance, options) {
     if (options === undefined) {
       return;
@@ -99,6 +119,7 @@ export default class PluginRoot extends Registry {
       this._warn(`Attempt to pass options to plugin "${instance.id}", which offers no config() method.`);
     }
   }
+
   _instantiate(plugin, options) {
     switch (typeof plugin) {
       case 'string':
@@ -108,9 +129,7 @@ export default class PluginRoot extends Registry {
           throw new Error(`Plugin class not found: ${plugin}`);
         }
         const instance = new pluginClass();
-        defineValues(instance, {
-          id: plugin
-        });
+        defineValues(instance, { id: plugin });
         this._tryConfig(instance, options);
         return instance;
       case 'function':
@@ -118,6 +137,7 @@ export default class PluginRoot extends Registry {
     }
     throw new Error(`Unexpected parameters: ${plugin}`);
   }
+
   _install(instance) {
     if (typeof instance.install !== 'function') {
       // TODO: introduce PluginError
@@ -127,7 +147,7 @@ export default class PluginRoot extends Registry {
       instance.installed = false;
       instance.install(this.MisoClient, this.context);
       instance.installed = true;
-    } catch (e) {
+    } catch(e) {
       // TODO: introduce PluginError
       throw e;
     }
@@ -141,39 +161,41 @@ export default class PluginRoot extends Registry {
     }
     this._events.emit('install', instance);
   }
+
   _register(lib) {
     super._register(lib);
     this._fulfillUseRequests(lib.id);
   }
+
   _fulfillUseRequests(id) {
     const requests = this._useRequests[id];
     if (requests) {
       for (const options of requests) {
         try {
           this.use(id, options);
-        } catch (e) {
+        } catch(e) {
           this._error(e);
         }
       }
       delete this._useRequests[id];
     }
   }
+
   async _tryRegisterRemotely(id) {
     if (id.startsWith('std:')) {
       try {
         await this._registerStdRemotely(id);
         return;
-      } catch (e) {
+      } catch(e) {
         console.error(e);
       }
     }
     // TODO: try as URL
     throw new Error(`Cannot register plugin remotely: ${id}`);
   }
+
   async _registerStdRemotely(id) {
-    const {
-      version
-    } = this._root;
+    const { version } = this._root;
     const request = version === 'dev' ? `plugin:${id}@dev:${MisoClient.uuid}` : `plugin:${id}@${version}`;
 
     // check if such script already exists
@@ -191,25 +213,28 @@ export default class PluginRoot extends Registry {
     const Plugin = await new Resources().get(request);
     !this.isRegistered(id) && this.register(Plugin);
   }
+
 }
 
 /**
  * The interface of extended features only for plugin developers.
  */
 class PluginContext {
+
   constructor(root, classes) {
-    delegateGetters(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addUrlPass', 'whenInstalled', 'whenRegistered']);
-    defineValues(this, {
-      classes
-    });
+    delegateGetters(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addUrlPass', 'setCustomFetch', 'whenInstalled', 'whenRegistered']);
+    defineValues(this, { classes });
   }
+
 }
 
 /**
  * The interface of plugin features exposed to MisoClient.
  */
-class Plugins {
+ class Plugins {
+
   constructor(root) {
     delegateGetters(this, root, ['installed', 'registered', 'isInstalled', 'isRegistered', 'whenInstalled', 'whenRegistered', 'get', 'register', 'use', 'install']);
   }
-}
+
+}

package/{dist/es → src}/plugin/urls.js

@@ -1,6 +1,7 @@
 export function getPluginScriptUrl(id, version, currentScript) {
   // TODO: look up by manifest
   const pkgName = id.slice(4);
+  
   if (version === 'dev') {
     const src = currentScript.src;
     const searchIndex = src.indexOf('?');
@@ -12,4 +13,4 @@ export function getPluginScriptUrl(id, version, currentScript) {
   } else {
     return `https://cdn.jsdelivr.net/npm/@miso.ai/client-sdk@${version}/dist/umd/plugins/${pkgName}.min.js`;
   }
-}
+}

package/{dist/es → src}/plugin/user.js

@@ -1,90 +1,84 @@
 import { uuidv4, asString, trimObj, Component, delegateProperties, getOrComputeFromStorage } from '@miso.ai/commons';
+
 const PLUGIN_ID = 'std:user';
+
 export default class UserPlugin extends Component {
+
   static get id() {
     return PLUGIN_ID;
   }
+
   constructor() {
     super('user');
     this._contexts = new WeakMap();
   }
+
   install(MisoClient, context) {
     context.addSubtree(this);
     MisoClient.on('create', this._injectClient.bind(this));
     context.addPayloadPass(this._modifyPayload.bind(this));
   }
+
   _injectClient(client) {
     const context = new UserContext(this);
     this._contexts.set(client, context);
     delegateProperties(client.context, context, ['anonymous_id', 'user_id', 'user_hash']);
   }
-  _modifyPayload(_ref) {
-    let {
-      client,
-      apiGroup,
-      apiName,
-      payload
-    } = _ref;
-    return apiGroup === 'interactions' && apiName === 'upload' ? this._modifyPayloadForInteractions(client, payload) : this._modifyPayloadForOthers(client, payload);
+
+  _modifyPayload({ client, apiGroup, apiName, payload }) {
+    return apiGroup === 'interactions' && apiName === 'upload' ?
+      this._modifyPayloadForInteractions(client, payload) : this._modifyPayloadForOthers(client, payload);
   }
+
   _modifyPayloadForOthers(client, payload) {
-    const {
-      user_id,
-      user_hash,
-      anonymous_id
-    } = client.context;
-    const userInfo = user_id ? {
-      user_id,
-      user_hash
-    } : {
-      anonymous_id
-    };
-    return Object.assign({}, userInfo, payload);
+    const { user_id, user_hash, anonymous_id } = client.context;
+    const userInfo = user_id ? { user_id, user_hash } : { anonymous_id };
+    return { ...userInfo, ...payload };
   }
-  _modifyPayloadForInteractions(client, _ref2) {
-    let {
-      data
-    } = _ref2;
-    const {
-      anonymous_id,
-      user_id
-    } = client.context;
-    const baseObj = trimObj({
-      anonymous_id,
-      user_id
-    });
-    data = data.map(obj => Object.assign({}, baseObj, obj));
-    return {
-      data
-    };
+
+  _modifyPayloadForInteractions(client, { data }) {
+    const { anonymous_id, user_id } = client.context;
+    const baseObj = trimObj({ anonymous_id, user_id });
+    data = data.map(obj => ({ ...baseObj, ...obj }));
+    return { data };
   }
+
 }
+
 function getAutoAnonymousId() {
   return getOrComputeFromStorage('miso_anonymous_id', uuidv4);
 }
+
 class UserContext {
+
   constructor(plugin) {
     this._plugin = plugin;
   }
+
   get anonymous_id() {
     return this._anonymousId || this._autoAnonymousId || (this._autoAnonymousId = getAutoAnonymousId());
   }
+
   set anonymous_id(value) {
     value = asString(value);
     this._anonymousId = value;
     this._plugin._events.emit('set', `anonymous_id = '${value}'`);
   }
+
   get user_id() {
     return this._userId;
   }
+
   set user_id(value) {
     value = asString(value);
     this._userId = value;
     this._plugin._events.emit('set', `user_id = '${value}'`);
   }
+
   get user_hash() {
     return this._userHash;
   }
+
   set user_hash(value) {
     if (typeof value !== 'string' && typeof value !== 'undefined') {
       throw new Error(`User hash must be a string`);
@@ -92,4 +86,5 @@ class UserContext {
     this._userHash = value;
     this._plugin._events.emit('set', `user_hash = '${value}'`);
   }
-}
+
+}

package/{dist/es → src}/root.js

@@ -1,11 +1,12 @@
 import { delegateGetters, Component } from '@miso.ai/commons';
-import version from './version';
-import PluginRoot from './plugin/plugin-root';
+import version from './version.js';
+import PluginRoot from './plugin/plugin-root.js';
 
 /**
  * The hidden singleton root component that oversees all client components.
  */
 class Root extends Component {
+
   constructor() {
     super();
     this._events._replays.add('create');
@@ -13,17 +14,22 @@ class Root extends Component {
     this._clients = [];
     this._payloadPasses = [];
     this._urlPasses = [];
+    this._customFetch = undefined;
     this.version = version || 'dev';
   }
+
   get instances() {
-    return [...this._clients]; // write protection
+    return [ ...this._clients]; // write protection
   }
 
   async any() {
     return this._clients[0] || this._any || (this._any = (await this._events.once('create')).data);
   }
+
 }
+
 export const root = new Root();
+
 export function init(MisoClient) {
   const pluginRoot = root._pluginRoot;
   root.MisoClient = pluginRoot.MisoClient = MisoClient;
@@ -31,7 +37,8 @@ export function init(MisoClient) {
   delegateGetters(MisoClient, pluginRoot, ['plugins']);
   return MisoClient;
 }
+
 export function register(client) {
   root._clients.push(client);
   root._events.emit('create', client);
-}
+}

package/src/utils.js

@@ -0,0 +1 @@
+export { viewable } from '@miso.ai/commons';

package/src/version.js

@@ -0,0 +1 @@
+export default '1.8.1-beta.0';

package/dist/es/api/ask.js

@@ -1,85 +0,0 @@
-const _excluded = ["pollingInterval", "signal", "stallTimeout"];
-function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-import { polling, signals, StallTimeoutAbortController } from '@miso.ai/commons';
-import ApiBase from './base';
-export default class Ask extends ApiBase {
-  constructor(api) {
-    super(api, 'ask');
-  }
-  async questions(payload) {
-    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    if (typeof payload === 'string' && payload.charAt(0) !== '{') {
-      return new Answer(this, {
-        question_id: payload
-      }, options);
-    }
-    const response = await this._run('questions', payload, options);
-    return new Answer(this, response, options);
-  }
-  async _questions(payload, options) {
-    return this._run('questions', payload, options);
-  }
-  async _get(questionId, options) {
-    return this._run(`questions/${questionId}/answer`, undefined, Object.assign({}, options, {
-      method: 'GET'
-    }));
-  }
-}
-class Answer {
-  constructor(api, _ref) {
-    let {
-      question_id
-    } = _ref;
-    let options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-    this._api = api;
-    this._questionId = question_id;
-    this._ac = new AbortController();
-    this._options = options;
-  }
-  get questionId() {
-    return this._questionId;
-  }
-  async get(options) {
-    return this._api._get(this._questionId, Object.assign({}, this._options, options));
-  }
-  abort(reason) {
-    this._ac.abort(reason);
-  }
-  [Symbol.asyncIterator]() {
-    var _this = this;
-    const fetch = async function () {
-      let {
-        signal
-      } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      // TODO: pass signal
-      const response = await _this.get();
-      return [response, response.finished];
-    };
-    let _this$_options = this._options,
-      {
-        pollingInterval: interval,
-        signal,
-        stallTimeout = 30000
-      } = _this$_options,
-      options = _objectWithoutPropertiesLoose(_this$_options, _excluded);
-    const stac = new StallTimeoutAbortController(stallTimeout);
-    signal = signals.any(this._ac.signal, stac.signal, signal);
-    let prevResponse;
-    const onResponse = (response, finished) => {
-      if (finished) {
-        stac.clear();
-      } else if (isUpdated(prevResponse, response)) {
-        stac.touch();
-      }
-      prevResponse = response;
-    };
-    return polling(fetch, Object.assign({
-      interval,
-      signal,
-      onResponse
-    }, options))[Symbol.asyncIterator]();
-  }
-}
-function isUpdated(prev, curr) {
-  return !prev || prev.answer_stage !== curr.answer_stage || prev.answer.length !== curr.answer.length;
-}