@miso.ai/client-sdk-codegen 1.11.6-beta.0

package/dist/cjs/codegen.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.codegen = codegen;
+var workflows = _interopRequireWildcard(require("./workflow/index.js"));
+const _excluded = ["workflow"];
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+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; }
+function normalizeOptions() {
+  let _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let {
+      workflow
+    } = _ref,
+    options = _objectWithoutPropertiesLoose(_ref, _excluded);
+  // turn workflow into camel case
+  if (!workflow) {
+    throw new Error('Workflow is required');
+  }
+  workflow = workflow.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
+  return Object.assign({
+    workflow
+  }, options);
+}
+function codegen(options) {
+  options = normalizeOptions(options);
+  const {
+    workflow
+  } = options;
+  if (!workflows[workflow]) {
+    throw new Error(`Workflow "${workflow}" is not found`);
+  }
+  return workflows[workflow](options);
+}

package/dist/cjs/features.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.autoQuery = autoQuery;
+var _utils = require("./utils.js");
+function autoQuery(autoQuery) {
+  return autoQuery ? `workflow.autoQuery(${typeof autoQuery === 'object' ? (0, _utils.format)(autoQuery, {
+    multiline: true
+  }) : ''});` : '';
+}

package/dist/cjs/index.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  workflows: true
+};
+exports.workflows = void 0;
+var _params = require("./params.js");
+Object.keys(_params).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _params[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _params[key];
+    }
+  });
+});
+var _codegen = require("./codegen.js");
+Object.keys(_codegen).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _codegen[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _codegen[key];
+    }
+  });
+});
+var _index = require("./spec/index.js");
+Object.keys(_index).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _index[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _index[key];
+    }
+  });
+});
+var _workflows = _interopRequireWildcard(require("./workflow/index.js"));
+exports.workflows = _workflows;
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }

package/dist/cjs/params.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.decodeParameters = decodeParameters;
+exports.encodeParameters = encodeParameters;
+function encodeParameters() {
+  let params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  // JSON string -> base64
+  return base64Encode(JSON.stringify(params));
+}
+function decodeParameters(params) {
+  // base64 -> JSON string
+  return params ? JSON.parse(base64Decode(params)) : {};
+}
+function base64Encode(str) {
+  return typeof window !== 'undefined' ? window.btoa(str) : Buffer.from(str).toString('base64');
+}
+function base64Decode(str) {
+  return typeof window !== 'undefined' ? window.atob(str) : Buffer.from(str, 'base64').toString();
+}

package/dist/cjs/spec/features.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FEATURES = void 0;
+exports.getFeatures = getFeatures;
+var _workflows = require("./workflows.js");
+const FEATURES = exports.FEATURES = [{
+  slug: 'use-api',
+  name: 'useApi()',
+  workflows: (0, _workflows.resolveWorkflows)('*')
+}, {
+  slug: 'use-link',
+  name: 'useLink()',
+  workflows: (0, _workflows.resolveWorkflows)('ahes')
+}, {
+  slug: 'follow-up',
+  name: 'Follow Up',
+  workflows: (0, _workflows.resolveWorkflows)('a')
+}, {
+  slug: 'auto-query',
+  name: 'Auto Query',
+  workflows: (0, _workflows.resolveWorkflows)('ahes')
+}, {
+  slug: 'autocomplete',
+  name: 'Autocomplete',
+  workflows: (0, _workflows.resolveWorkflows)('hs')
+}, {
+  slug: 'pagination',
+  name: 'Pagination',
+  workflows: (0, _workflows.resolveWorkflows)('hs')
+}, {
+  slug: 'facets',
+  name: 'Facets',
+  workflows: (0, _workflows.resolveWorkflows)('hs')
+}];
+function getFeatures(workflow) {
+  return FEATURES.filter(feature => feature.workflows.includes(workflow));
+}

package/dist/cjs/spec/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.presets = void 0;
+var _hybridSearch = require("../workflow/hybrid-search.js");
+const presets = exports.presets = Object.freeze({
+  hybridSearch: Object.keys(_hybridSearch.presets)
+});

package/dist/cjs/spec/workflows.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.WORKFLOWS = void 0;
+exports.resolveWorkflows = resolveWorkflows;
+var _commons = require("@miso.ai/commons");
+const WORKFLOWS = exports.WORKFLOWS = [{
+  slug: 'ask'
+}, {
+  slug: 'hybrid-search'
+}, {
+  slug: 'explore'
+}, {
+  slug: 'search'
+}, {
+  slug: 'recommendation'
+}].map(workflow => Object.assign({}, workflow, {
+  name: (0, _commons.kebabOrSnakeToHuman)(workflow.slug)
+}));
+const ABV_TO_WORKFLOW = WORKFLOWS.reduce((map, workflow) => {
+  map[workflow.slug.charAt(0)] = workflow;
+  return map;
+}, {});
+function resolveWorkflows(abvs) {
+  if (abvs === '*') {
+    return [...WORKFLOWS];
+  }
+  return abvs.split('').map(abv => {
+    if (!ABV_TO_WORKFLOW[abv]) {
+      throw new Error(`Workflow "${abv}" is not found`);
+    }
+    return ABV_TO_WORKFLOW[abv];
+  });
+}

package/dist/cjs/templates.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createClient = createClient;
+exports.misocmd = misocmd;
+var _utils = require("./utils.js");
+function misocmd(body) {
+  return `
+const misocmd = window.misocmd || (window.misocmd = []);
+misocmd.push(async () => {
+${(0, _utils.indent)(body, 2)}
+});
+`.trim();
+}
+function createClient(options) {
+  return `
+// client
+const MisoClient = window.MisoClient;
+const client = new MisoClient(${clientOptions(options)});
+`.trim();
+}
+function clientOptions() {
+  let {
+    apiKey,
+    apiKeyParam = false
+  } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  if (!apiKeyParam) {
+    return `'${apiKey}'`;
+  }
+  apiKeyParam = apiKeyParam === true ? 'api-key' : apiKeyParam;
+  return `new URLSearchParams(window.location.search).get('${apiKeyParam}') || '${apiKey}'`;
+}

package/dist/cjs/utils.js

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.format = format;
+exports.indent = indent;
+exports.resolvePreset = resolvePreset;
+const _excluded = ["preset"];
+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; }
+function indent(str) {
+  let level = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1;
+  return str.replace(/\n/g, '\n' + ' '.repeat(level));
+}
+
+/**
+ * Format a JavaScript value to literal string
+ * @param {*} value
+ * @param {Object} options
+ * @param {boolean} options.multiline - Whether to use multiline
+ * @returns {string}
+ */
+function format(value) {
+  let {
+    multiline = false
+  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  // use single quote
+  // no quote for simple key in object
+  return JSON.stringify(value, null, multiline ? 2 : 0).replace(/"/g, "'").replace(/\s*:\s*/g, ': ');
+}
+
+/**
+ * Resolve preset options
+ * @param {Object} presets - Available presets
+ * @param {Object} options - Options to resolve
+ * @param {string} options.preset - Preset to use
+ * @param {Object} options - Other options
+ * @returns {Object} Resolved options
+ */
+function resolvePreset(presets) {
+  let _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  let {
+      preset
+    } = _ref,
+    options = _objectWithoutPropertiesLoose(_ref, _excluded);
+  if (!preset) {
+    return options;
+  }
+  if (!presets[preset]) {
+    throw new Error(`Preset "${preset}" is not found`);
+  }
+  // let rest of options override
+  return Object.assign({}, presets[preset], options);
+}

package/dist/cjs/workflow/hybrid-search.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.hybridSearch = hybridSearch;
+exports.presets = void 0;
+var _utils = require("../utils.js");
+var _templates = require("../templates.js");
+var _features = require("../features.js");
+const presets = exports.presets = Object.freeze({
+  standard: Object.freeze({
+    workflow: 'hybrid-search',
+    autoQuery: true,
+    autocomplete: true,
+    facets: ['categories'],
+    answerBox: true
+  })
+});
+function hybridSearch(options) {
+  options = (0, _utils.resolvePreset)(presets, options);
+  return {
+    js: js(options),
+    html: html(options)
+  };
+}
+function js(options) {
+  return (0, _templates.misocmd)(`
+${(0, _templates.createClient)(options)}
+
+// workflow
+const workflow = client.ui.hybridSearch;
+
+// setup: TODO
+
+// render Miso elements
+await client.ui.ready;
+const { templates, wireAnswerBox } = MisoClient.ui.defaults.hybridSearch;
+const rootElement = document.querySelector('#miso-hybrid-search-combo');
+rootElement.innerHTML = templates.root();
+wireAnswerBox(client, rootElement);
+
+${(0, _features.autoQuery)(options.autoQuery)}
+`);
+}
+function html(options) {
+  return `
+<h1 class="hero-title">Miso Hybrid Search</h1>
+<div id="miso-hybrid-search-combo" class="miso-hybrid-search-combo"></div>
+`.trim();
+}

package/dist/cjs/workflow/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  workflows: true
+};
+exports.workflows = void 0;
+var _hybridSearch = require("./hybrid-search.js");
+Object.keys(_hybridSearch).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _hybridSearch[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _hybridSearch[key];
+    }
+  });
+});
+const workflows = exports.workflows = ['hybrid-search'];

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@miso.ai/client-sdk-codegen",
+  "description": "Client SDK code generator",
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "src/index.js",
+  "exports": {
+    "import": "./src/index.js",
+    "require": "./dist/cjs/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build:clean": "npx rimraf dist",
+    "build:cjs": "BABEL_ENV=cjs npx babel src --root-mode upward --out-dir dist/cjs",
+    "build": "npm run build:clean && npm run build:cjs"
+  },
+  "repository": "MisoAI/miso-client-js-sdk",
+  "homepage": "https://misoai.github.io/miso-client-js-sdk/sdk",
+  "license": "MIT",
+  "contributors": [
+    "simonpai <simon.pai@askmiso.com>"
+  ],
+  "bugs": {
+    "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
+  },
+  "dependencies": {
+    "@miso.ai/commons": "1.11.6-beta.0"
+  },
+  "version": "1.11.6-beta.0"
+}

package/src/codegen.js

@@ -0,0 +1,23 @@
+import * as workflows from './workflow/index.js';
+
+function normalizeOptions({ workflow, ...options } = {}) {
+  // turn workflow into camel case
+  if (!workflow) {
+    throw new Error('Workflow is required');
+  }
+  workflow = workflow.replace(/-([a-z])/g, (_, c) => c.toUpperCase());
+
+  return {
+    workflow,
+    ...options,
+  };
+}
+
+export function codegen(options) {
+  options = normalizeOptions(options);
+  const { workflow } = options;
+  if (!workflows[workflow]) {
+    throw new Error(`Workflow "${workflow}" is not found`);
+  }
+  return workflows[workflow](options);
+}

package/src/features.js

@@ -0,0 +1,5 @@
+import { format } from './utils.js';
+
+export function autoQuery(autoQuery) {
+  return autoQuery ? `workflow.autoQuery(${typeof autoQuery === 'object' ? format(autoQuery, { multiline: true }) : ''});` : '';
+}

package/src/index.js

@@ -0,0 +1,4 @@
+export * from './params.js';
+export * from './codegen.js';
+export * from './spec/index.js';
+export * as workflows from './workflow/index.js';

package/src/params.js

@@ -0,0 +1,17 @@
+export function encodeParameters(params = {}) {
+  // JSON string -> base64
+  return base64Encode(JSON.stringify(params));
+}
+
+export function decodeParameters(params) {
+  // base64 -> JSON string
+  return params ? JSON.parse(base64Decode(params)) : {};
+}
+
+function base64Encode(str) {
+  return typeof window !== 'undefined' ? window.btoa(str) : Buffer.from(str).toString('base64');
+}
+
+function base64Decode(str) {
+  return typeof window !== 'undefined' ? window.atob(str) : Buffer.from(str, 'base64').toString();
+}

package/src/spec/features.js

@@ -0,0 +1,43 @@
+import { resolveWorkflows } from './workflows.js';
+
+export const FEATURES = [
+  {
+    slug: 'use-api',
+    name: 'useApi()',
+    workflows: resolveWorkflows('*'),
+  },
+  {
+    slug: 'use-link',
+    name: 'useLink()',
+    workflows: resolveWorkflows('ahes'),
+  },
+  {
+    slug: 'follow-up',
+    name: 'Follow Up',
+    workflows: resolveWorkflows('a'),
+  },
+  {
+    slug: 'auto-query',
+    name: 'Auto Query',
+    workflows: resolveWorkflows('ahes'),
+  },
+  {
+    slug: 'autocomplete',
+    name: 'Autocomplete',
+    workflows: resolveWorkflows('hs'),
+  },
+  {
+    slug: 'pagination',
+    name: 'Pagination',
+    workflows: resolveWorkflows('hs'),
+  },
+  {
+    slug: 'facets',
+    name: 'Facets',
+    workflows: resolveWorkflows('hs'),
+  },
+];
+
+export function getFeatures(workflow) {
+  return FEATURES.filter(feature => feature.workflows.includes(workflow));
+}

package/src/spec/index.js

@@ -0,0 +1,5 @@
+import { presets as hybridSearchPresets } from '../workflow/hybrid-search.js';
+
+export const presets = Object.freeze({
+  hybridSearch: Object.keys(hybridSearchPresets),
+});

package/src/spec/workflows.js

@@ -0,0 +1,39 @@
+import { kebabOrSnakeToHuman } from '@miso.ai/commons';
+
+export const WORKFLOWS = ([
+  {
+    slug: 'ask',
+  },
+  {
+    slug: 'hybrid-search',
+  },
+  {
+    slug: 'explore',
+  },
+  {
+    slug: 'search',
+  },
+  {
+    slug: 'recommendation',
+  },
+]).map(workflow => ({
+  ...workflow,
+  name: kebabOrSnakeToHuman(workflow.slug),
+}));
+
+const ABV_TO_WORKFLOW = WORKFLOWS.reduce((map, workflow) => {
+  map[workflow.slug.charAt(0)] = workflow;
+  return map;
+}, {});
+
+export function resolveWorkflows(abvs) {
+  if (abvs === '*') {
+    return [...WORKFLOWS];
+  }
+  return abvs.split('').map(abv => {
+    if (!ABV_TO_WORKFLOW[abv]) {
+      throw new Error(`Workflow "${abv}" is not found`);
+    }
+    return ABV_TO_WORKFLOW[abv];
+  });
+}

package/src/templates.js

@@ -0,0 +1,26 @@
+import { indent } from './utils.js';
+
+export function misocmd(body) {
+  return `
+const misocmd = window.misocmd || (window.misocmd = []);
+misocmd.push(async () => {
+${indent(body, 2)}
+});
+`.trim();
+}
+
+export function createClient(options) {
+  return `
+// client
+const MisoClient = window.MisoClient;
+const client = new MisoClient(${clientOptions(options)});
+`.trim();
+}
+
+function clientOptions({ apiKey, apiKeyParam = false } = {}) {
+  if (!apiKeyParam) {
+    return `'${apiKey}'`;
+  }
+  apiKeyParam = apiKeyParam === true ? 'api-key' : apiKeyParam;
+  return `new URLSearchParams(window.location.search).get('${apiKeyParam}') || '${apiKey}'`;
+}

package/src/utils.js

@@ -0,0 +1,38 @@
+export function indent(str, level = 1) {
+  return str.replace(/\n/g, '\n' + ' '.repeat(level));
+}
+
+/**
+ * Format a JavaScript value to literal string
+ * @param {*} value
+ * @param {Object} options
+ * @param {boolean} options.multiline - Whether to use multiline
+ * @returns {string}
+ */
+export function format(value, { multiline = false } = {}) {
+  // use single quote
+  // no quote for simple key in object
+  return JSON.stringify(value, null, multiline ? 2 : 0).replace(/"/g, "'").replace(/\s*:\s*/g, ': ');
+}
+
+/**
+ * Resolve preset options
+ * @param {Object} presets - Available presets
+ * @param {Object} options - Options to resolve
+ * @param {string} options.preset - Preset to use
+ * @param {Object} options - Other options
+ * @returns {Object} Resolved options
+ */
+export function resolvePreset(presets, { preset, ...options } = {}) {
+  if (!preset) {
+    return options;
+  }
+  if (!presets[preset]) {
+    throw new Error(`Preset "${preset}" is not found`);
+  }
+  // let rest of options override
+  return {
+    ...presets[preset],
+    ...options,
+  };
+}

package/src/workflow/hybrid-search.js

@@ -0,0 +1,48 @@
+import { resolvePreset } from '../utils.js';
+import { misocmd, createClient } from '../templates.js';
+import { autoQuery } from '../features.js';
+
+export const presets = Object.freeze({
+  standard: Object.freeze({
+    workflow: 'hybrid-search',
+    autoQuery: true,
+    autocomplete: true,
+    facets: ['categories'],
+    answerBox: true,
+  }),
+});
+
+export function hybridSearch(options) {
+  options = resolvePreset(presets, options);
+  return {
+    js: js(options),
+    html: html(options),
+  };
+}
+
+function js(options) {
+  return misocmd(`
+${createClient(options)}
+
+// workflow
+const workflow = client.ui.hybridSearch;
+
+// setup: TODO
+
+// render Miso elements
+await client.ui.ready;
+const { templates, wireAnswerBox } = MisoClient.ui.defaults.hybridSearch;
+const rootElement = document.querySelector('#miso-hybrid-search-combo');
+rootElement.innerHTML = templates.root();
+wireAnswerBox(client, rootElement);
+
+${autoQuery(options.autoQuery)}
+`);
+}
+
+function html(options) {
+  return `
+<h1 class="hero-title">Miso Hybrid Search</h1>
+<div id="miso-hybrid-search-combo" class="miso-hybrid-search-combo"></div>
+`.trim();
+}

package/src/workflow/index.js

@@ -0,0 +1,3 @@
+export * from './hybrid-search.js';
+
+export const workflows = ['hybrid-search'];