@miso.ai/client-sdk-core 1.12.3-beta.5 → 1.12.3

package/dist/cjs/api/base.js

@@ -31,6 +31,12 @@ class ApiBase extends _commons.Component {
       payload,
       options
     });
+    const headers = this._headers({
+      apiGroup,
+      apiName,
+      payload,
+      options
+    });
     payload = this._preprocess({
       apiGroup,
       apiName,
@@ -42,6 +48,7 @@ class ApiBase extends _commons.Component {
       apiName,
       payload,
       url,
+      headers,
       options
     };
     this._events.emit('request', Object.assign({}, requestData, bulkInfo));
@@ -52,15 +59,31 @@ class ApiBase extends _commons.Component {
     this._events.emit('response', Object.assign({}, responseData, bulkInfo));
     return this._postprocess(responseData);
   }
+  _headers({
+    apiGroup,
+    apiName,
+    payload,
+    options
+  }) {
+    return this.helpers.applyHeaderPasses(this, {
+      apiGroup,
+      apiName,
+      payload,
+      headers: {},
+      options
+    });
+  }
   _preprocess({
     apiGroup,
     apiName,
-    payload
+    payload,
+    options
   }) {
     return this.helpers.applyPayloadPasses(this, {
       apiGroup,
       apiName,
-      payload
+      payload,
+      options
     });
   }
   _url({
@@ -81,13 +104,16 @@ class ApiBase extends _commons.Component {
         apiGroup,
         apiName,
         url,
+        headers,
         payload,
         options: {
           bulk
         } = {}
       } = _ref,
       options = _objectWithoutPropertiesLoose(_ref.options, _excluded);
-    return bulk ? this.helpers.fetchForBulk(apiGroup, apiName, payload) : this.helpers.fetch(url, payload, options);
+    return bulk ? this.helpers.fetchForBulk(apiGroup, apiName, payload) : this.helpers.fetch(url, payload, Object.assign({}, options, {
+      headers
+    }));
   }
   _postprocess({
     response

package/dist/cjs/api/helpers.js

@@ -15,20 +15,14 @@ class ApiHelpers {
   async fetch(url, payload, {
     method = 'POST',
     headers,
-    timeout,
-    sendApiKeyByHeader
+    timeout
   } = {}) {
     const {
       apiKey,
       request = {}
     } = this._client.options;
     timeout = timeout || request.timeout;
-    sendApiKeyByHeader = sendApiKeyByHeader || request.sendApiKeyByHeader;
-    if (sendApiKeyByHeader) {
-      headers = Object.assign({}, headers, {
-        'X-API-KEY': apiKey
-      });
-    }
+
     // TODO: external abort signal
     // TODO: organize arguments
     const body = method !== 'GET' && payload != undefined ? JSON.stringify(payload) : undefined;
@@ -113,15 +107,13 @@ class ApiHelpers {
       throw new Error(`Send beacon unsuccessful: ${url}`);
     }
   }
-  url(paths, options = {}) {
+  url(paths) {
     const {
-      apiKey,
-      request = {}
+      apiKey
     } = this._client.options;
-    const sendApiKeyByHeader = options.sendApiKeyByHeader || request.sendApiKeyByHeader;
     const apiName = paths.filter(s => s).join('/');
     const url = `${this.getApiEndpoint(apiName)}/${apiName}`;
-    return sendApiKeyByHeader ? url : `${url}?api_key=${window.encodeURIComponent(apiKey)}`;
+    return `${url}?api_key=${window.encodeURIComponent(apiKey)}`;
   }
   getApiEndpoint(apiName) {
     const {
@@ -170,5 +162,29 @@ class ApiHelpers {
     }
     return payload;
   }
+  applyHeaderPasses(component, {
+    apiGroup,
+    apiName,
+    payload,
+    headers,
+    options
+  }) {
+    const client = this._client;
+    for (const pass of this._root._headersPasses) {
+      try {
+        headers = pass({
+          client,
+          apiGroup,
+          apiName,
+          payload,
+          headers,
+          options
+        }) || headers;
+      } catch (e) {
+        (component._error || console.error)(e);
+      }
+    }
+    return headers;
+  }
 }
 exports.default = ApiHelpers;

package/dist/cjs/client.js

@@ -54,6 +54,9 @@ class MisoClient extends _commons.Component {
     if (!options.apiKey) {
       throw new Error('Require API key to initialize miso client.');
     }
+    if (options.request && options.request.sendApiKeyByHeader) {
+      console.warn('`sendApiKeyByHeader` option is deprecated. Please call `MisoClient.plugins.use("std:header-api-key");` instead.');
+    }
     options.dataEndpoint = options.dataEndpoint || options.apiHost;
     options.eventEndpoint = options.eventEndpoint || options.apiHost;
     delete options.apiHost;

package/dist/cjs/plugin/api-patch.js

@@ -0,0 +1,77 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _commons = require("@miso.ai/commons");
+const _excluded = ["payload"],
+  _excluded2 = ["_meta", "metadata"],
+  _excluded3 = ["user_type"];
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+const PLUGIN_ID = 'std:api-patch';
+class ApiPatchPlugin extends _commons.Component {
+  static get id() {
+    return PLUGIN_ID;
+  }
+  constructor() {
+    super('api-patch');
+  }
+  install(MisoClient, context) {
+    context.addSubtree(this);
+    context.addPayloadPass(this._patchApiPayload.bind(this));
+  }
+  _patchApiPayload(args) {
+    let {
+        payload
+      } = args,
+      rest = _objectWithoutPropertiesLoose(args, _excluded);
+    if (!payload) {
+      return payload; // the GET request
+    }
+    payload = this._copyMetadataToMeta(payload, rest);
+    payload = this._suppressMetadata(payload, rest);
+    payload = this._suppressUserType(payload, rest);
+    return payload;
+  }
+  _copyMetadataToMeta(payload, {
+    apiGroup
+  }) {
+    switch (apiGroup) {
+      case _commons.API.GROUP.ASK:
+        if (payload.metadata) {
+          return Object.assign({}, payload, {
+            _meta: payload.metadata
+          });
+        }
+        return payload;
+      default:
+        return payload;
+    }
+  }
+  _suppressMetadata(payload, {
+    apiGroup
+  }) {
+    switch (apiGroup) {
+      case _commons.API.GROUP.SEARCH:
+      case _commons.API.GROUP.RECOMMENDATION:
+        const rest = _objectWithoutPropertiesLoose(payload, _excluded2);
+        return rest;
+      default:
+        return payload;
+    }
+  }
+  _suppressUserType(payload, {
+    apiGroup
+  }) {
+    switch (apiGroup) {
+      case _commons.API.GROUP.SEARCH:
+      case _commons.API.GROUP.RECOMMENDATION:
+        const rest = _objectWithoutPropertiesLoose(payload, _excluded3);
+        return rest;
+      default:
+        return payload;
+    }
+  }
+}
+exports.default = ApiPatchPlugin;

package/dist/cjs/plugin/context.js

@@ -0,0 +1,178 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _commons = require("@miso.ai/commons");
+const {
+  GROUP,
+  NAME
+} = _commons.API;
+const PLUGIN_ID = 'std:context';
+class ContextPlugin extends _commons.Component {
+  static get id() {
+    return PLUGIN_ID;
+  }
+  constructor() {
+    super('context');
+  }
+  install(MisoClient, context) {
+    context.addSubtree(this);
+    MisoClient.on('create', this._injectClient.bind(this));
+    context.addHeadersPass(this._modifyHeaders.bind(this));
+    context.addPayloadPass(this._modifyPayload.bind(this));
+  }
+  _injectClient(client) {
+    const context = new ClientContext(this);
+    (0, _commons.delegateProperties)(client.context, context, ['anonymous_id', 'user_id', 'user_hash', 'user_type', 'site', 'auth']);
+  }
+  _modifyHeaders({
+    client,
+    headers
+  }) {
+    const {
+      auth
+    } = client.context;
+    if (auth) {
+      headers = Object.assign({}, headers, {
+        Authorization: auth
+      });
+    }
+    return headers;
+  }
+  _modifyPayload({
+    client,
+    apiGroup,
+    apiName,
+    payload
+  }) {
+    if (!payload) {
+      return payload; // the GET request
+    }
+    switch (apiGroup) {
+      case GROUP.INTERACTIONS:
+        if (apiName === NAME.UPLOAD) {
+          return this._modifyPayloadForInteractions(client, payload);
+        }
+        return payload;
+      default:
+        return this._modifyPayloadForQueries(client, payload);
+    }
+  }
+  _modifyPayloadForQueries(client, payload) {
+    const {
+      user_id,
+      user_hash,
+      user_type,
+      anonymous_id,
+      site
+    } = client.context;
+    const userInfo = user_id ? {
+      user_id,
+      user_type,
+      user_hash
+    } : {
+      anonymous_id
+    };
+    const metadata = site ? {
+      site
+    } : undefined;
+    return (0, _commons.mergeApiPayloads)(payload, Object.assign({}, userInfo, {
+      metadata
+    }));
+  }
+  _modifyPayloadForInteractions(client, {
+    data
+  }) {
+    const {
+      anonymous_id,
+      user_id,
+      site
+    } = client.context;
+    const userInfo = {
+      anonymous_id,
+      user_id
+    };
+    const custom_context = site ? {
+      site
+    } : undefined;
+    const context = custom_context ? {
+      custom_context
+    } : undefined;
+    data = data.map(obj => (0, _commons.mergeInteractions)(obj, Object.assign({}, userInfo, {
+      context
+    })));
+    return {
+      data
+    };
+  }
+}
+exports.default = ContextPlugin;
+let _pageBasedAutoAnonymousId;
+function getAutoAnonymousId() {
+  // 1. Cache the value for the page
+  // 2. Get and set the value from cookies/localStorage is possible
+  // 3. In case cookies/localStorage are disabled, generate a new value for each page
+  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = (0, _commons.getOrComputeFromStorage)('miso_anonymous_id', _commons.uuidv4));
+}
+class ClientContext {
+  constructor(plugin) {
+    this._plugin = plugin;
+    this._props = {};
+  }
+  get anonymous_id() {
+    return this._props.anonymous_id || getAutoAnonymousId();
+  }
+  set anonymous_id(value) {
+    this._requireString('anonymous_id', value);
+    this._set('anonymous_id', value);
+  }
+  get user_id() {
+    return this._props.user_id;
+  }
+  set user_id(value) {
+    this._requireString('user_id', value);
+    this._set('user_id', value);
+  }
+  get user_hash() {
+    return this._props.user_hash;
+  }
+  set user_hash(value) {
+    this._requireString('user_hash', value);
+    this._set('user_hash', value);
+  }
+  get user_type() {
+    return this._props.user_type;
+  }
+  set user_type(value) {
+    this._requireString('user_type', value);
+    this._set('user_type', value);
+  }
+  get site() {
+    return this._props.site;
+  }
+  set site(value) {
+    this._requireString('site', value);
+    this._set('site', value);
+  }
+  get auth() {
+    return this._props.auth;
+  }
+  set auth(value) {
+    this._requireString('auth', value);
+    this._set('auth', value);
+  }
+
+  // helpers //
+  _set(key, value) {
+    this._props[key] = value;
+    this._plugin._events.emit('set', `${key} = '${value}'`);
+  }
+  _requireString(key, value) {
+    if (typeof value !== 'string' && typeof value !== 'undefined') {
+      throw new Error(`${key} must be a string`);
+    }
+    return value;
+  }
+}

package/dist/cjs/plugin/header-api-key.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+const PLUGIN_ID = 'std:header-api-key';
+class HeaderApiKeyPlugin {
+  static get id() {
+    return PLUGIN_ID;
+  }
+  install(MisoClient, context) {
+    context.addUrlPass(this._modifyUrl.bind(this));
+    context.addHeadersPass(this._modifyHeaders.bind(this));
+    MisoClient.debug(`<plugin:${PLUGIN_ID}>`, '[info]', `Send API key in header`);
+  }
+  _modifyUrl({
+    url
+  }) {
+    // remove api_key from url
+    return url.replace(/[?&]api_key=[^&]*/g, '');
+  }
+  _modifyHeaders({
+    client,
+    headers
+  }) {
+    const {
+      apiKey
+    } = client.options;
+    return apiKey ? Object.assign({}, headers, {
+      'X-API-KEY': apiKey
+    }) : headers;
+  }
+}
+exports.default = HeaderApiKeyPlugin;

package/dist/cjs/plugin/index.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "ApiPlugin", {
+Object.defineProperty(exports, "ApiPatchPlugin", {
   enumerable: true,
   get: function () {
-    return _api.default;
+    return _apiPatch.default;
   }
 });
 Object.defineProperty(exports, "AutoEventsPlugin", {
@@ -15,6 +15,18 @@ Object.defineProperty(exports, "AutoEventsPlugin", {
     return _autoEvents.default;
   }
 });
+Object.defineProperty(exports, "ContextPlugin", {
+  enumerable: true,
+  get: function () {
+    return _context.default;
+  }
+});
+Object.defineProperty(exports, "HeaderApiKeyPlugin", {
+  enumerable: true,
+  get: function () {
+    return _headerApiKey.default;
+  }
+});
 Object.defineProperty(exports, "InteractionsPlugin", {
   enumerable: true,
   get: function () {
@@ -33,16 +45,11 @@ Object.defineProperty(exports, "PageInfoPlugin", {
     return _pageInfo.default;
   }
 });
-Object.defineProperty(exports, "UserPlugin", {
-  enumerable: true,
-  get: function () {
-    return _user.default;
-  }
-});
-var _user = _interopRequireDefault(require("./user.js"));
+var _context = _interopRequireDefault(require("./context.js"));
 var _pageInfo = _interopRequireDefault(require("./page-info.js"));
 var _autoEvents = _interopRequireDefault(require("./auto-events.js"));
 var _interactions = _interopRequireDefault(require("./interactions.js"));
 var _nativeFetch = _interopRequireDefault(require("./native-fetch.js"));
-var _api = _interopRequireDefault(require("./api.js"));
+var _apiPatch = _interopRequireDefault(require("./api-patch.js"));
+var _headerApiKey = _interopRequireDefault(require("./header-api-key.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }

package/dist/cjs/plugin/plugin-root.js

@@ -92,6 +92,12 @@ class PluginRoot extends _commons.Registry {
     }
     this._root._payloadPasses.push(pass);
   }
+  addHeadersPass(pass) {
+    if (typeof pass !== 'function') {
+      throw new Error(`Expect parameter to be a function: ${pass}`);
+    }
+    this._root._headersPasses.push(pass);
+  }
   addUrlPass(pass) {
     if (typeof pass !== 'function') {
       throw new Error(`Expect parameter to be a function: ${pass}`);
@@ -233,7 +239,7 @@ class PluginRoot extends _commons.Registry {
 exports.default = PluginRoot;
 class PluginContext {
   constructor(root, classes) {
-    (0, _commons.delegateGetters)(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addUrlPass', 'setCustomFetch', 'setCustomSendBeacon', 'onHubUpdate', 'onHubEmit', 'whenInstalled', 'whenRegistered']);
+    (0, _commons.delegateGetters)(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addHeadersPass', 'addUrlPass', 'setCustomFetch', 'setCustomSendBeacon', 'onHubUpdate', 'onHubEmit', 'whenInstalled', 'whenRegistered']);
     (0, _commons.defineValues)(this, {
       classes
     });

package/dist/cjs/root.js

@@ -21,6 +21,7 @@ class Root extends _commons.Component {
     this._pluginRoot = new _pluginRoot.default(this);
     this._clients = [];
     this._payloadPasses = [];
+    this._headersPasses = [];
     this._urlPasses = [];
     this._customFetch = undefined;
     this._customSendBeacon = undefined;

package/dist/cjs/version.js

@@ -4,4 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = exports.default = '1.12.3-beta.5';
+var _default = exports.default = '1.12.3';

package/package.json

@@ -29,7 +29,7 @@
     "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
   },
   "dependencies": {
-    "@miso.ai/commons": "1.12.3-beta.5"
+    "@miso.ai/commons": "1.12.3"
   },
-  "version": "1.12.3-beta.5"
+  "version": "1.12.3"
 }

package/src/api/base.js

@@ -17,8 +17,9 @@ export default class ApiBase extends Component {
     const bulkInfo = bulk ? { bulk: this.helpers.bulkInfo } : undefined;
     const apiGroup = this._apiPath;
     const url = this._url({ apiGroup, apiName, payload, options });
+    const headers = this._headers({ apiGroup, apiName, payload, options });
     payload = this._preprocess({ apiGroup, apiName, payload, options });
-    const requestData = { apiGroup, apiName, payload, url, options };
+    const requestData = { apiGroup, apiName, payload, url, headers, options };
     this._events.emit('request', { ...requestData, ...bulkInfo });
     const response = await this._send(requestData);
     const responseData = { ...requestData, response };
@@ -26,8 +27,12 @@ export default class ApiBase extends Component {
     return this._postprocess(responseData);
   }
 
-  _preprocess({ apiGroup, apiName, payload }) {
-    return this.helpers.applyPayloadPasses(this, { apiGroup, apiName, payload });
+  _headers({ apiGroup, apiName, payload, options }) {
+    return this.helpers.applyHeaderPasses(this, { apiGroup, apiName, payload, headers: {}, options });
+  }
+
+  _preprocess({ apiGroup, apiName, payload, options }) {
+    return this.helpers.applyPayloadPasses(this, { apiGroup, apiName, payload, options });
   }
 
   _url({ apiGroup, apiName, options }) {
@@ -35,8 +40,8 @@ export default class ApiBase extends Component {
     return this.helpers.applyUrlPasses(this, { apiGroup, apiName, url, options });
   }
 
-  async _send({ apiGroup, apiName, url, payload, options: { bulk, ...options } = {} }) {
-    return bulk ? this.helpers.fetchForBulk(apiGroup, apiName, payload) : this.helpers.fetch(url, payload, options);
+  async _send({ apiGroup, apiName, url, headers, payload, options: { bulk, ...options } = {} }) {
+    return bulk ? this.helpers.fetchForBulk(apiGroup, apiName, payload) : this.helpers.fetch(url, payload, { ...options, headers });
   }
 
   _postprocess({ response }) {

package/src/api/helpers.js

@@ -13,15 +13,10 @@ export default class ApiHelpers {
     method = 'POST',
     headers,
     timeout,
-    sendApiKeyByHeader,
   } = {}) {
     const { apiKey, request = {} } = this._client.options;
     timeout = timeout || request.timeout;
-    sendApiKeyByHeader = sendApiKeyByHeader || request.sendApiKeyByHeader;
 
-    if (sendApiKeyByHeader) {
-      headers = { ...headers, 'X-API-KEY': apiKey };
-    }
     // TODO: external abort signal
     // TODO: organize arguments
     const body = method !== 'GET' && payload != undefined ? JSON.stringify(payload) : undefined;
@@ -91,12 +86,11 @@ export default class ApiHelpers {
     }
   }
 
-  url(paths, options = {}) {
-    const { apiKey, request = {} } = this._client.options;
-    const sendApiKeyByHeader = options.sendApiKeyByHeader || request.sendApiKeyByHeader;
+  url(paths) {
+    const { apiKey } = this._client.options;
     const apiName = paths.filter(s => s).join('/');
     const url = `${this.getApiEndpoint(apiName)}/${apiName}`;
-    return sendApiKeyByHeader ? url : `${url}?api_key=${window.encodeURIComponent(apiKey)}`;
+    return `${url}?api_key=${window.encodeURIComponent(apiKey)}`;
   }
 
   getApiEndpoint(apiName) {
@@ -131,4 +125,16 @@ export default class ApiHelpers {
     return payload;
   }
 
+  applyHeaderPasses(component, { apiGroup, apiName, payload, headers, options }) {
+    const client = this._client;
+    for (const pass of this._root._headersPasses) {
+      try {
+        headers = pass({ client, apiGroup, apiName, payload, headers, options }) || headers;
+      } catch(e) {
+        (component._error || console.error)(e);
+      }
+    }
+    return headers;
+  }
+
 }

package/src/client.js

@@ -54,6 +54,9 @@ class MisoClient extends Component {
     if (!options.apiKey) {
       throw new Error('Require API key to initialize miso client.');
     }
+    if (options.request && options.request.sendApiKeyByHeader) {
+      console.warn('`sendApiKeyByHeader` option is deprecated. Please call `MisoClient.plugins.use("std:header-api-key");` instead.');
+    }
 
     options.dataEndpoint = options.dataEndpoint || options.apiHost;
     options.eventEndpoint = options.eventEndpoint || options.apiHost;

package/src/plugin/api-patch.js

@@ -0,0 +1,68 @@
+import { Component, API } from '@miso.ai/commons';
+
+const PLUGIN_ID = 'std:api-patch';
+
+export default class ApiPatchPlugin extends Component {
+
+  static get id() {
+    return PLUGIN_ID;
+  }
+
+  constructor() {
+    super('api-patch');
+  }
+
+  install(MisoClient, context) {
+    context.addSubtree(this);
+    context.addPayloadPass(this._patchApiPayload.bind(this));
+  }
+
+  _patchApiPayload(args) {
+    let { payload, ...rest } = args;
+    if (!payload) {
+      return payload; // the GET request
+    }
+    payload = this._copyMetadataToMeta(payload, rest);
+    payload = this._suppressMetadata(payload, rest);
+    payload = this._suppressUserType(payload, rest);
+    return payload;
+  }
+
+  _copyMetadataToMeta(payload, { apiGroup }) {
+    switch (apiGroup) {
+      case API.GROUP.ASK:
+        if (payload.metadata) {
+          return {
+            ...payload,
+            _meta: payload.metadata,
+          };
+        }
+        return payload;
+      default:
+        return payload;
+    }
+  }
+
+  _suppressMetadata(payload, { apiGroup }) {
+    switch (apiGroup) {
+      case API.GROUP.SEARCH:
+      case API.GROUP.RECOMMENDATION:
+        const { _meta, metadata, ...rest } = payload;
+        return rest;
+      default:
+        return payload;
+    }
+  }
+
+  _suppressUserType(payload, { apiGroup }) {
+    switch (apiGroup) {
+      case API.GROUP.SEARCH:
+      case API.GROUP.RECOMMENDATION:
+        const { user_type, ...rest } = payload;
+        return rest;
+      default:
+        return payload;
+    }
+  }
+
+}

package/src/plugin/context.js

@@ -0,0 +1,153 @@
+import { API, uuidv4, Component, delegateProperties, getOrComputeFromStorage, mergeInteractions, mergeApiPayloads } from '@miso.ai/commons';
+
+const { GROUP, NAME } = API;
+
+const PLUGIN_ID = 'std:context';
+
+export default class ContextPlugin extends Component {
+
+  static get id() {
+    return PLUGIN_ID;
+  }
+
+  constructor() {
+    super('context');
+  }
+
+  install(MisoClient, context) {
+    context.addSubtree(this);
+    MisoClient.on('create', this._injectClient.bind(this));
+    context.addHeadersPass(this._modifyHeaders.bind(this));
+    context.addPayloadPass(this._modifyPayload.bind(this));
+  }
+
+  _injectClient(client) {
+    const context = new ClientContext(this);
+    delegateProperties(client.context, context, ['anonymous_id', 'user_id', 'user_hash', 'user_type', 'site', 'auth']);
+  }
+
+  _modifyHeaders({ client, headers }) {
+    const { auth } = client.context;
+    if (auth) {
+      headers = { ...headers, Authorization: auth };
+    }
+    return headers;
+  }
+
+  _modifyPayload({ client, apiGroup, apiName, payload }) {
+    if (!payload) {
+      return payload; // the GET request
+    }
+    switch (apiGroup) {
+      case GROUP.INTERACTIONS:
+        if (apiName === NAME.UPLOAD) {
+          return this._modifyPayloadForInteractions(client, payload);
+        }
+        return payload;
+      default:
+        return this._modifyPayloadForQueries(client, payload);
+    }
+  }
+
+  _modifyPayloadForQueries(client, payload) {
+    const { user_id, user_hash, user_type, anonymous_id, site } = client.context;
+    const userInfo = user_id ? { user_id, user_type, user_hash } : { anonymous_id };
+    const metadata = site ? { site } : undefined;
+    return mergeApiPayloads(payload, { ...userInfo, metadata });
+  }
+
+  _modifyPayloadForInteractions(client, { data }) {
+    const { anonymous_id, user_id, site } = client.context;
+    const userInfo = { anonymous_id, user_id };
+    const custom_context = site ? { site } : undefined;
+    const context = custom_context ? { custom_context } : undefined;
+    data = data.map(obj => mergeInteractions(obj, { ...userInfo, context }));
+    return { data };
+  }
+
+}
+
+let _pageBasedAutoAnonymousId;
+
+function getAutoAnonymousId() {
+  // 1. Cache the value for the page
+  // 2. Get and set the value from cookies/localStorage is possible
+  // 3. In case cookies/localStorage are disabled, generate a new value for each page
+  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = getOrComputeFromStorage('miso_anonymous_id', uuidv4));
+}
+
+class ClientContext {
+
+  constructor(plugin) {
+    this._plugin = plugin;
+    this._props = {};
+  }
+
+  get anonymous_id() {
+    return this._props.anonymous_id || getAutoAnonymousId();
+  }
+
+  set anonymous_id(value) {
+    this._requireString('anonymous_id', value);
+    this._set('anonymous_id', value);
+  }
+
+  get user_id() {
+    return this._props.user_id;
+  }
+
+  set user_id(value) {
+    this._requireString('user_id', value);
+    this._set('user_id', value);
+  }
+
+  get user_hash() {
+    return this._props.user_hash;
+  }
+
+  set user_hash(value) {
+    this._requireString('user_hash', value);
+    this._set('user_hash', value);
+  }
+
+  get user_type() {
+    return this._props.user_type;
+  }
+
+  set user_type(value) {
+    this._requireString('user_type', value);
+    this._set('user_type', value);
+  }
+
+  get site() {
+    return this._props.site;
+  }
+
+  set site(value) {
+    this._requireString('site', value);
+    this._set('site', value);
+  }
+
+  get auth() {
+    return this._props.auth;
+  }
+
+  set auth(value) {
+    this._requireString('auth', value);
+    this._set('auth', value);
+  }
+
+  // helpers //
+  _set(key, value) {
+    this._props[key] = value;
+    this._plugin._events.emit('set', `${key} = '${value}'`);
+  }
+
+  _requireString(key, value) {
+    if (typeof value !== 'string' && typeof value !== 'undefined') {
+      throw new Error(`${key} must be a string`);
+    }
+    return value;
+  }
+
+}

package/src/plugin/header-api-key.js

@@ -0,0 +1,25 @@
+const PLUGIN_ID = 'std:header-api-key';
+
+export default class HeaderApiKeyPlugin {
+
+  static get id() {
+    return PLUGIN_ID;
+  }
+
+  install(MisoClient, context) {
+    context.addUrlPass(this._modifyUrl.bind(this));
+    context.addHeadersPass(this._modifyHeaders.bind(this));
+    MisoClient.debug(`<plugin:${PLUGIN_ID}>`, '[info]', `Send API key in header`);
+  }
+
+  _modifyUrl({ url }) {
+    // remove api_key from url
+    return url.replace(/[?&]api_key=[^&]*/g, '');
+  }
+
+  _modifyHeaders({ client, headers }) {
+    const { apiKey } = client.options;
+    return apiKey ? { ...headers, 'X-API-KEY': apiKey } : headers;
+  }
+
+}

package/src/plugin/index.js

@@ -1,6 +1,7 @@
-export { default as UserPlugin } from './user.js';
+export { default as ContextPlugin } from './context.js';
 export { default as PageInfoPlugin } from './page-info.js';
 export { default as AutoEventsPlugin } from './auto-events.js';
 export { default as InteractionsPlugin } from './interactions.js';
 export { default as NativeFetchPlugin } from './native-fetch.js';
-export { default as ApiPlugin } from './api.js';
+export { default as ApiPatchPlugin } from './api-patch.js';
+export { default as HeaderApiKeyPlugin } from './header-api-key.js';

package/src/plugin/plugin-root.js

@@ -94,6 +94,13 @@ export default class PluginRoot extends Registry {
     this._root._payloadPasses.push(pass);
   }
 
+  addHeadersPass(pass) {
+    if (typeof pass !== 'function') {
+      throw new Error(`Expect parameter to be a function: ${pass}`);
+    }
+    this._root._headersPasses.push(pass);
+  }
+
   addUrlPass(pass) {
     if (typeof pass !== 'function') {
       throw new Error(`Expect parameter to be a function: ${pass}`);
@@ -243,7 +250,7 @@ export default class PluginRoot extends Registry {
 class PluginContext {
 
   constructor(root, classes) {
-    delegateGetters(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addUrlPass', 'setCustomFetch', 'setCustomSendBeacon', 'onHubUpdate', 'onHubEmit', 'whenInstalled', 'whenRegistered']);
+    delegateGetters(this, root, ['getPluginClass', 'addSubtree', 'addPayloadPass', 'addHeadersPass', 'addUrlPass', 'setCustomFetch', 'setCustomSendBeacon', 'onHubUpdate', 'onHubEmit', 'whenInstalled', 'whenRegistered']);
     defineValues(this, { classes });
   }
 

package/src/root.js

@@ -13,6 +13,7 @@ class Root extends Component {
     this._pluginRoot = new PluginRoot(this);
     this._clients = [];
     this._payloadPasses = [];
+    this._headersPasses = [];
     this._urlPasses = [];
     this._customFetch = undefined;
     this._customSendBeacon = undefined;

package/src/version.js

@@ -1 +1 @@
-export default '1.12.3-beta.5';
+export default '1.12.3';

package/dist/cjs/plugin/api.js

@@ -1,42 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-const _excluded = ["_meta"];
-function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
-const PLUGIN_ID = 'std:api';
-class ApiPlugin extends _commons.Component {
-  static get id() {
-    return PLUGIN_ID;
-  }
-  constructor() {
-    super('api');
-  }
-  install(MisoClient, context) {
-    context.addSubtree(this);
-    context.addPayloadPass(this._suppressMetaObject.bind(this));
-  }
-  _suppressMetaObject(args) {
-    if (!this._shallSuppressMetaObject(args)) {
-      return args.payload;
-    }
-    const {} = args,
-      payload = _objectWithoutPropertiesLoose(args.payload, _excluded);
-    return payload;
-  }
-  _shallSuppressMetaObject({
-    apiGroup,
-    apiName
-  }) {
-    switch (apiGroup) {
-      case _commons.API.GROUP.SEARCH:
-      case _commons.API.GROUP.RECOMMENDATION:
-        return true;
-    }
-    return false;
-  }
-}
-exports.default = ApiPlugin;

package/dist/cjs/plugin/user.js

@@ -1,139 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _commons = require("@miso.ai/commons");
-const {
-  GROUP,
-  NAME
-} = _commons.API;
-const PLUGIN_ID = 'std:user';
-class UserPlugin extends _commons.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);
-    (0, _commons.delegateProperties)(client.context, context, ['anonymous_id', 'user_id', 'user_hash', 'user_type']);
-  }
-  _modifyPayload({
-    client,
-    apiGroup,
-    apiName,
-    payload
-  }) {
-    if (apiGroup === GROUP.INTERACTIONS && apiName === NAME.UPLOAD) {
-      return this._modifyPayloadForInteractions(client, payload);
-    }
-    if (apiGroup === GROUP.ASK && apiName === NAME.QUESTIONS) {
-      return this._modifyPayloadForAsk(client, payload);
-    }
-    return 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);
-  }
-  _modifyPayloadForAsk(client, payload) {
-    const {
-      user_id,
-      user_hash,
-      user_type,
-      anonymous_id
-    } = client.context;
-    const userInfo = user_id ? {
-      user_id,
-      user_hash
-    } : {
-      anonymous_id
-    };
-    if (user_id && user_type) {
-      userInfo.user_type = user_type;
-    }
-    return Object.assign({}, userInfo, payload);
-  }
-  _modifyPayloadForInteractions(client, {
-    data
-  }) {
-    const {
-      anonymous_id,
-      user_id
-    } = client.context;
-    const userInfo = (0, _commons.trimObj)({
-      anonymous_id,
-      user_id
-    });
-    data = data.map(obj => Object.assign({}, userInfo, obj));
-    return {
-      data
-    };
-  }
-}
-exports.default = UserPlugin;
-let _pageBasedAutoAnonymousId;
-function getAutoAnonymousId() {
-  // 1. Cache the value for the page
-  // 2. Get and set the value from cookies/localStorage is possible
-  // 3. In case cookies/localStorage are disabled, generate a new value for each page
-  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = (0, _commons.getOrComputeFromStorage)('miso_anonymous_id', _commons.uuidv4));
-}
-class UserContext {
-  constructor(plugin) {
-    this._plugin = plugin;
-  }
-  get anonymous_id() {
-    return this._anonymousId || getAutoAnonymousId();
-  }
-  set anonymous_id(value) {
-    value = (0, _commons.asString)(value);
-    this._anonymousId = value;
-    this._plugin._events.emit('set', `anonymous_id = '${value}'`);
-  }
-  get user_id() {
-    return this._userId;
-  }
-  set user_id(value) {
-    value = (0, _commons.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`);
-    }
-    this._userHash = value;
-    this._plugin._events.emit('set', `user_hash = '${value}'`);
-  }
-  get user_type() {
-    return this._userType;
-  }
-  set user_type(value) {
-    this._userType = value;
-    this._plugin._events.emit('set', `user_type = '${value}'`);
-  }
-}

package/src/plugin/api.js

@@ -1,37 +0,0 @@
-import { Component, API } from '@miso.ai/commons';
-
-const PLUGIN_ID = 'std:api';
-
-export default class ApiPlugin extends Component {
-
-  static get id() {
-    return PLUGIN_ID;
-  }
-
-  constructor() {
-    super('api');
-  }
-
-  install(MisoClient, context) {
-    context.addSubtree(this);
-    context.addPayloadPass(this._suppressMetaObject.bind(this));
-  }
-
-  _suppressMetaObject(args) {
-    if (!this._shallSuppressMetaObject(args)) {
-      return args.payload;
-    }
-    const { payload: { _meta, ...payload } = {} } = args;
-    return payload;
-  }
-
-  _shallSuppressMetaObject({ apiGroup, apiName }) {
-    switch (apiGroup) {
-      case API.GROUP.SEARCH:
-      case API.GROUP.RECOMMENDATION:
-        return true;
-    }
-    return false;
-  }
-
-}

package/src/plugin/user.js

@@ -1,120 +0,0 @@
-import { API, uuidv4, asString, trimObj, Component, delegateProperties, getOrComputeFromStorage } from '@miso.ai/commons';
-
-const { GROUP, NAME } = API;
-
-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', 'user_type']);
-  }
-
-  _modifyPayload({ client, apiGroup, apiName, payload }) {
-    if (apiGroup === GROUP.INTERACTIONS && apiName === NAME.UPLOAD) {
-      return this._modifyPayloadForInteractions(client, payload);
-    }
-    if (apiGroup === GROUP.ASK && apiName === NAME.QUESTIONS) {
-      return this._modifyPayloadForAsk(client, payload);
-    }
-    return 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 { ...userInfo, ...payload };
-  }
-
-  _modifyPayloadForAsk(client, payload) {
-    const { user_id, user_hash, user_type, anonymous_id } = client.context;
-    const userInfo = user_id ? { user_id, user_hash } : { anonymous_id };
-    if (user_id && user_type) {
-      userInfo.user_type = user_type;
-    }
-    return { ...userInfo, ...payload };
-  }
-
-  _modifyPayloadForInteractions(client, { data }) {
-    const { anonymous_id, user_id } = client.context;
-    const userInfo = trimObj({ anonymous_id, user_id });
-    data = data.map(obj => ({ ...userInfo, ...obj }));
-    return { data };
-  }
-
-}
-
-let _pageBasedAutoAnonymousId;
-
-function getAutoAnonymousId() {
-  // 1. Cache the value for the page
-  // 2. Get and set the value from cookies/localStorage is possible
-  // 3. In case cookies/localStorage are disabled, generate a new value for each page
-  return _pageBasedAutoAnonymousId || (_pageBasedAutoAnonymousId = getOrComputeFromStorage('miso_anonymous_id', uuidv4));
-}
-
-class UserContext {
-
-  constructor(plugin) {
-    this._plugin = plugin;
-  }
-
-  get anonymous_id() {
-    return this._anonymousId || 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`);
-    }
-    this._userHash = value;
-    this._plugin._events.emit('set', `user_hash = '${value}'`);
-  }
-
-  get user_type() {
-    return this._userType;
-  }
-
-  set user_type(value) {
-    this._userType = value;
-    this._plugin._events.emit('set', `user_type = '${value}'`);
-  }
-
-}