@miso.ai/doggoganger-api 0.0.1

package/lib/api/ask.js

@@ -0,0 +1,200 @@
+import { trimObj } from '../utils.js';
+import { answer, searchResults, questions, completions, utils } from '../data/index.js';
+
+const CPS = 100;
+const ITEMS_LOADING_TIME = 3;
+const QUESTION_REVISED_TIME = 3;
+const STAGES = [
+  {
+    name: 'fetch',
+    duration: 1.5,
+    text: `Checking the question and fetching results... `,
+  },
+  {
+    name: 'verify',
+    duration: 1.5,
+    text: `Verifying results... `,
+  },
+  {
+    name: 'generate',
+    duration: 1.5,
+    text: `Generating answer... `,
+  },
+];
+
+const MODE_QUESTION = 0;
+const MODE_SEARCH = 1;
+
+export default class Ask {
+
+  constructor(options = {}) {
+    this._options = options;
+    this._answers = new Map();
+  }
+
+  questions(payload, options = {}) {
+    const answer = this._createAnswer(MODE_QUESTION, payload, options);
+    const { question_id } = answer;
+    return { question_id };
+  }
+
+  search(payload, options = {}) {
+    const miso_id = utils.uuid();
+    const result = { miso_id, ...searchResults(payload) };
+    if (payload.answer === undefined || payload.answer) {
+      result.question_id = this._createAnswer(MODE_SEARCH, payload, options).question_id;
+    }
+    return result;
+  }
+
+  autocomplete({ q, completion_fields = ['title'], rows = 5 }) {
+    return {
+      completions: completions({ q, completion_fields, rows }),
+    };
+  }
+
+  search_autocomplete(args) {
+    return this.autocomplete(args);
+  }
+
+  _createAnswer(mode, payload, options = {}) {
+    const answer = new Answer(mode, payload, { ...this._options, ...options });
+    this._answers.set(answer.question_id, answer);
+    return answer;
+  }
+
+  answer(questionId) {
+    const answer = this._answers.get(questionId);
+    if (!answer) {
+      const error = new Error(`Question not found: ${questionId}`);
+      error.status = 404;
+      throw error;
+    }
+    return answer.get();
+  }
+
+  related_questions(payload) {
+    const miso_id = utils.uuid();
+    return {
+      related_questions: [...questions(payload)],
+      miso_id,
+    };
+  }
+
+  trending_questions(payload) {
+    return this.related_questions(payload);
+  }
+
+}
+
+class Answer {
+
+  constructor(mode, payload, { answerFormat, answerSampling, answerLanguages, ...options } = {}) {
+    this._mode = mode;
+    this._options = Object.freeze(options);
+    const timestamp = this.timestamp = Date.now();
+    this._data = answer({ ...payload, timestamp }, { answerFormat, answerSampling, answerLanguages });
+  }
+
+  get question_id() {
+    return this._data.question_id;
+  }
+
+  get searchResults() {
+    const { products, total, facet_counts } = this._data;
+    return trimObj({ products, total, facet_counts });
+  }
+
+  get() {
+    const now = Date.now();
+    const elapsed = (now - this.timestamp) * (this._options.speedRate || 1) / 1000;
+    const question = this._question(elapsed);
+    const [answer_stage, answer, finished, revision] = this._answer(elapsed);
+    const sources = this._sources(elapsed, finished);
+    const related_resources = this._related_resources(elapsed, finished);
+    const followup_questions = this._followup_questions(elapsed, finished);
+    const { question_id, datetime, parent_question_id, images } = this._data;
+
+    switch (this._mode) {
+      case MODE_QUESTION:
+        return {
+          answer,
+          answer_stage,
+          datetime,
+          finished,
+          revision,
+          parent_question_id,
+          question,
+          question_id,
+          images,
+          sources,
+          related_resources,
+          followup_questions,
+        };
+      case MODE_SEARCH:
+        return {
+          answer,
+          answer_stage,
+          datetime,
+          finished,
+          revision,
+          question_id,
+          images,
+          sources,
+        };
+      default:
+        throw new Error(`Unknown mode: ${this._mode}`);
+    }
+  }
+
+  _question(elapsed) {
+    const { question } = this._data;
+    return elapsed > QUESTION_REVISED_TIME ? `${question} [revised]` : question;
+  }
+
+  _answer(elapsed) {
+    let elapsedInStage = elapsed;
+    for (const stage of STAGES) {
+      elapsedInStage -= stage.duration;
+      if (elapsedInStage < 0) {
+        return [stage.name, stage.text, false, elapsed];
+      }
+    }
+    const { answer } = this._data;
+    const length = Math.floor(elapsedInStage * CPS);
+    const finished = length >= answer.length;
+    const text = finished ? answer : answer.slice(0, length);
+    return ['result', text, finished, elapsed];
+  }
+
+  _sources(elapsed, finished) {
+    const { sources } = this._data;
+    if (finished) {
+      return sources;
+    }
+    const { length } = sources;
+    const loaded = Math.floor(length * elapsed / ITEMS_LOADING_TIME);
+    return sources.slice(0, loaded);
+  }
+
+  _related_resources(elapsed, finished) {
+    const { related_resources } = this._data;
+    if (finished) {
+      return related_resources;
+    }
+    const { length } = related_resources;
+    const loaded = Math.floor(length * elapsed / ITEMS_LOADING_TIME);
+    return related_resources.slice(0, loaded);
+  }
+
+  _followup_questions(elapsed, finished) {
+    const { followup_questions } = this._data;
+    if (finished || !followup_questions) {
+      return followup_questions;
+    }
+    const { length } = followup_questions;
+    const loaded = Math.floor(length * elapsed / ITEMS_LOADING_TIME);
+    return followup_questions.slice(0, loaded);
+  }
+
+}

package/lib/api/index.js

@@ -0,0 +1,17 @@
+import Ask from './ask.js';
+import Search from './search.js';
+import Recommendation from './recommendation.js';
+import Interactions from './interactions.js';
+import Products from './products.js';
+
+export default class Api {
+
+  constructor(options) {
+    this.ask = new Ask(options);
+    this.search = new Search(options);
+    this.recommendation = new Recommendation(options);
+    this.interactions = new Interactions(options);
+    this.products = new Products(options);
+  }
+
+}

package/lib/api/interactions.js

@@ -0,0 +1,13 @@
+export default class Interactions {
+
+  constructor(options) {
+    this._options = options;
+  }
+
+  upload(records) {
+    return [];
+  }
+
+  // TODO: delete
+
+}

package/lib/api/products.js

@@ -0,0 +1,32 @@
+export default class Products {
+
+  constructor(options) {
+    this._options = options;
+  }
+
+  upload(records) {
+    return [];
+  }
+
+  batchDelete(ids) {
+    return [];
+  }
+
+  ids() {
+    const ids = [];
+    for (let i = 0; i < 5000; i++) {
+      ids.push(mockProductId(i));
+    }
+    return {
+      ids,
+    };
+  }
+
+  // TODO: status
+
+}
+
+function mockProductId(i) {
+  const prefix = i < 10 ? 'p_000' : i < 100 ? 'p_00' : i < 1000 ? 'p_0' : 'p_';
+  return `${prefix}${i}`;
+}

package/lib/api/recommendation.js

@@ -0,0 +1,21 @@
+import { products } from '../data/index.js';
+
+export default class Recommendation {
+
+  constructor(options) {
+    this._options = options;
+  }
+
+  user_to_products({ rows = 5 }) {
+    return {
+      products: [...products({ rows })],
+    };
+  }
+
+  product_to_products({ rows = 5 }) {
+    return {
+      products: [...products({ rows })],
+    };
+  }
+
+}

package/lib/api/search.js

@@ -0,0 +1,21 @@
+import { products, completions } from '../data/index.js';
+
+export default class Search {
+
+  constructor(options) {
+    this._options = options;
+  }
+
+  search({ rows = 5 }) {
+    return {
+      products: [...products({ rows })],
+    };
+  }
+
+  autocomplete({ q, completion_fields = ['title'], rows = 5 }) {
+    return {
+      completions: completions({ q, completion_fields, rows }),
+    };
+  }
+
+}

package/lib/data/answers.js

@@ -0,0 +1,69 @@
+import { fields, utils } from '@miso.ai/lorem';
+import { articles } from './articles.js';
+import { images as _images } from './images.js';
+import { questions } from './questions.js';
+import { facets as generateFacetFields } from './facets.js';
+
+const { randomInt, formatDatetime, sample, uuid, shuffle, excludeHtml } = utils;
+
+export function answer({
+  _ctrl = {},
+  question,
+  parent_question_id,
+  fl = ['cover_image', 'url'],
+  source_fl = ['cover_image', 'url'],
+  related_resource_fl = ['cover_image', 'url'],
+  cite_link = false,
+  cite_start = '[',
+  cite_end = ']',
+  rows = 10,
+  facets,
+  timestamp = Date.now(),
+  _meta: {
+    page = 0,
+  } = {},
+}, { answerFormat = 'markdown', answerSampling, answerLanguages = [] } = {}) {
+
+  const question_id = uuid();
+  const datetime = formatDatetime(timestamp);
+
+  const sampling = answerSampling !== undefined ? Math.max(0, Math.min(1, answerSampling)) : undefined;
+  const features = answerLanguages.length ? answerLanguages.map(language => `lang-${language}`) : undefined;
+
+  const related_resources = [...articles({ rows: sampleRandomInt(6, 8, sampling), fl: related_resource_fl })].map(excludeHtml);
+  const images = [..._images({ rows: sampleRandomInt(2, 12, sampling) })];
+  const sources = [...articles({ rows: sampleRandomInt(4, 6, sampling), fl: source_fl })].map(excludeHtml);
+
+  const total = _ctrl.total !== undefined ? _ctrl.total : randomInt(1000, 10000);
+  const products = [...articles({ rows: Math.min(total - page * rows, rows), fl })].map(excludeHtml);
+
+  const facet_counts = facets ? { facet_fields: generateFacetFields({ facets, _ctrl }) } : undefined;
+
+  const citation = {
+    link: cite_link !== '0' && !!cite_link,
+    start: cite_start,
+    end: cite_end,
+    unused: shuffle([...Array(sources.length).keys()]),
+  };
+  const answer = fields.answer({ sources, citation, format: answerFormat, sampling, features });
+  const followup_questions = [...questions({ rows: sampleRandomInt(3, 6) })];
+
+  return {
+    question,
+    question_id,
+    ...(parent_question_id && { parent_question_id }),
+    datetime,
+    answer,
+    images,
+    sources,
+    products,
+    total,
+    facet_counts,
+    related_resources,
+    followup_questions,
+  };
+}
+
+function sampleRandomInt(min, max, sampling) {
+  return randomInt(sample(min, sampling), sample(max, sampling));
+}

package/lib/data/articles.js

@@ -0,0 +1,50 @@
+import { fields, utils } from '@miso.ai/lorem';
+
+const FIELDS = new Set([
+  'cover_image',
+  'url',
+  'created_at',
+  'updated_at',
+  'published_at',
+]);
+
+export function *articles({ rows, ...options } = {}) {
+  for (let i = 0; i < rows; i++) {
+    yield article({ ...options, index: i });
+  }
+}
+
+function article({ html, fl = [] } = {}) {
+  const id = utils.id();
+
+  const article = {
+    product_id: id,
+    authors: fields.authors(),
+    categories: [],
+    tags: fields.tags(),
+    title: fields.title({ size: [4, 10] }),
+    snippet: fields.description({ size: [20, 40] }),
+    html: fields.html(html),
+  };
+
+  for (const field of fl) {
+    if (FIELDS.has(field)) {
+      article[field] = property(article, field);
+    }
+  }
+
+  return article;
+}
+
+function property({ product_id }, field) {
+  switch (field) {
+    case 'cover_image':
+      return fields.image();
+    case 'url':
+      return `/products/${product_id}`;
+    case 'created_at':
+    case 'updated_at':
+    case 'published_at':
+      return fields.date();
+  }
+}

package/lib/data/completions.js

@@ -0,0 +1,37 @@
+import { fields, utils } from '@miso.ai/lorem';
+
+export function completions({ q, completion_fields, rows } = {}) {
+  let index = 0;
+  const result = {};
+  for (const field of completion_fields) {
+    result[field] = completionsForField(field, q, index, rows);
+    index += rows;
+  }
+  return result;
+}
+
+function completionsForField(field, q, index, rows) {
+  const completions = [];
+  for (let i = 0; i < rows; i++) {
+    completions.push(completion(field, q, index));
+  }
+  return completions;
+}
+
+function completion(field, q, index) {
+  const text = fields.title();
+  const i = utils.randomInt(0, text.length);
+  const prefix = text.substring(0, i);
+  const suffix = text.substring(i);
+  return {
+    text: `${prefix}${q}${suffix}`,
+    text_with_markups: `${marked(prefix)}${q}${marked(suffix)}`,
+    text_with_inverted_markups: `${prefix}${marked(q)}${suffix}`,
+    _field: field,
+    _index: index,
+  };
+}
+
+function marked(text) {
+  return text.length > 0 ? `<mark>${text}</mark>` : '';
+}

package/lib/data/facets.js

@@ -0,0 +1,58 @@
+import { fields } from '@miso.ai/lorem';
+
+const DEFAULT_FACET_SIZE = 5;
+const MAX_FACET_SIZE = 10;
+const MIN_FACET_SIZE = 1;
+
+const HIGHEST_FACET_COUNT_RATIO_RANGE = [1000, 5000];
+const NEXT_FACET_COUNT_RATIO_RANGE = [0.75, 0.25];
+
+export function facets({ facets, ...options } = {}) {
+  const results = {};
+  for (let facet of facets) {
+    if (typeof facet === 'string') {
+      facet = { field: facet };
+    }
+    results[facet.field] = facetCountList(facet, options);
+  }
+  return results;
+}
+
+function facetCountList(facet, { _ctrl = {}, ...options } = {}) {
+  let { field, size = DEFAULT_FACET_SIZE } = facet;
+  size = _ctrl.total === 0 ? 0 : Math.max(MIN_FACET_SIZE, Math.min(size, MAX_FACET_SIZE));
+  let count = highestFacetCountValue(field, options);
+
+  const usedTerms = new Set();
+  const results = [];
+  for (let i = 0; i < size; i++) {
+    results.push([ getTerm(field, usedTerms), count ]);
+    count = nextFacetCountValue(count, field, options);
+  }
+  return results;
+}
+
+function getTerm(field, usedTerms) {
+  if (usedTerms.size > 50) {
+    return fields.term({ field });
+  }
+  while (true) {
+    const term = fields.term({ field });
+    if (!usedTerms.has(term)) {
+      usedTerms.add(term);
+      return term;
+    }
+  }
+}
+
+function highestFacetCountValue(field, options) {
+  // TODO: capped at _ctrl.total
+  const [min, max] = HIGHEST_FACET_COUNT_RATIO_RANGE;
+  return Math.ceil(Math.random() * (max - min) + min);
+}
+
+function nextFacetCountValue(value, field, options) {
+  const [min, max] = NEXT_FACET_COUNT_RATIO_RANGE;
+  const ratio = Math.random() * (max - min) + min;
+  return Math.ceil(value * ratio);
+}

package/lib/data/images.js

@@ -0,0 +1,22 @@
+import { fields, utils } from '@miso.ai/lorem';
+
+export function *images({ rows, ...options } = {}) {
+  for (let i = 0; i < rows; i++) {
+    yield image({ ...options, index: i });
+  }
+}
+
+function image({ fl = [] } = {}) {
+  const id = utils.id();
+
+  return {
+    product_id: id,
+    image_src: fields.image({ size: [1200, 400] }),
+    image_alt: fields.title({ size: [2, 4] }),
+    title: fields.title({ size: [4, 10] }),
+    url: `/products/${id}`,
+    created_at: fields.date(),
+    updated_at: fields.date(),
+    published_at: fields.date(),
+  };
+}

package/lib/data/index.js

@@ -0,0 +1,8 @@
+export * from '@miso.ai/lorem';
+export * from './products.js';
+export * from './articles.js';
+export * from './questions.js';
+export * from './answers.js';
+export * from './search.js';
+export * from './completions.js';
+export * from './images.js';

package/lib/data/products.js

@@ -0,0 +1,29 @@
+import { fields, utils } from '@miso.ai/lorem';
+
+export function *products({ rows, ...options } = {}) {
+  for (let i = 0; i < rows; i++) {
+    yield product({ ...options, index: i });
+  }
+}
+
+function product({} = {}) {
+  const id = utils.id();
+  const prices = utils.repeat(fields.price, [1, 2]);
+  prices.sort();
+
+  return {
+    product_id: id,
+    authors: fields.authors(),
+    categories: [],
+    tags: fields.tags(),
+    title: fields.title(),
+    description: fields.description(),
+    //html,
+    cover_image: fields.image(),
+    url: `https://dummy.miso.ai/products/${id}`,
+    sale_price: prices[0],
+    original_price: prices[prices.length - 1],
+    rating: fields.rating(),
+    availability: fields.availability(),
+  };
+}

package/lib/data/questions.js

@@ -0,0 +1,11 @@
+import { fields } from '@miso.ai/lorem';
+
+export function *questions({ rows = 5, ...options } = {}) {
+  for (let i = 0; i < rows; i++) {
+    yield question({ ...options, index: i });
+  }
+}
+
+function question({} = {}) {
+  return fields.description({ size: [4, 8], punctuation: '?' });
+}

package/lib/data/search.js

@@ -0,0 +1,24 @@
+import { utils } from '@miso.ai/lorem';
+import { articles } from './articles.js';
+import { facets as generateFacetFields } from './facets.js';
+
+export function searchResults({
+  _ctrl = {},
+  q,
+  fl = ['cover_image', 'url'],
+  rows = 10,
+  facets,
+  _meta: {
+    page = 0,
+  } = {},
+}) {
+  const total = _ctrl.total !== undefined ? _ctrl.total : utils.randomInt(1000, 10000);
+  const products = [...articles({ rows: Math.min(total - page * rows, rows), fl })].map(utils.excludeHtml);
+  const facet_counts = facets ? { facet_fields: generateFacetFields({ facets, _ctrl }) } : undefined;
+
+  return {
+    products,
+    total,
+    facet_counts,
+  };
+}

package/lib/index.js

@@ -0,0 +1,4 @@
+export { default as Api } from './api/index.js';
+import * as data from './data/index.js';
+
+export { data };

package/lib/utils.js

@@ -0,0 +1,12 @@
+export function trimObj(obj) {
+  if (typeof obj !== 'object') {
+    return obj;
+  }
+  const trimmed = {};
+  for (const k in obj) {
+    if (Object.prototype.hasOwnProperty.call(obj, k) && obj[k] !== undefined) {
+      trimmed[k] = obj[k];
+    }
+  }
+  return trimmed;
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@miso.ai/doggoganger-api",
+  "description": "A dummy Miso API module",
+  "type": "module",
+  "main": "lib/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MisoAI/doggoganger.git"
+  },
+  "homepage": "https://github.com/MisoAI/doggoganger/",
+  "license": "MIT",
+  "contributors": [
+    "simonpai <simon.pai@askmiso.com>"
+  ],
+  "bugs": {
+    "url": "https://github.com/MisoAI/doggoganger/issues"
+  },
+  "dependencies": {
+    "@miso.ai/lorem": "0.0.1"
+  },
+  "version": "0.0.1"
+}

package/package.json.bak

@@ -0,0 +1,26 @@
+{
+  "name": "@miso.ai/doggoganger-api",
+  "description": "A dummy Miso API module",
+  "type": "module",
+  "main": "lib/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MisoAI/doggoganger.git"
+  },
+  "homepage": "https://github.com/MisoAI/doggoganger/",
+  "license": "MIT",
+  "contributors": [
+    "simonpai <simon.pai@askmiso.com>"
+  ],
+  "bugs": {
+    "url": "https://github.com/MisoAI/doggoganger/issues"
+  },
+  "dependencies": {
+    "@miso.ai/lorem": "file:packages/lorem"
+  }
+}