@miso.ai/doggoganger 0.9.0-beta.2

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+name: NPM publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    environment: production
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get version
+        id: version
+        run: |
+          VERSION=${{ github.event.release.tag_name }}
+          echo "::set-output name=version::$(echo $VERSION | sed -e 's/v//gI')"
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+      - run: git config --global user.name "${{ github.actor }}"
+      - run: git config --global user.email "github-action-${{ github.actor }}@users.noreply.github.com"
+      - run: npm run version ${{ steps.version.outputs.version }}
+      - run: npm publish
+        if: "!github.event.release.prerelease"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - run: npm publish --tag beta
+        if: "github.event.release.prerelease"
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Miso Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# doggoganger
+Mock API endpoint service for demo and testing

package/bin/version.js

@@ -0,0 +1,46 @@
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { writeFileSync, readFileSync, existsSync } from 'fs';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const VERSION_REGEXP = /^\d+\.\d+\.\d+(?:-beta\.\d+)?$/;
+const version = process.argv[2];
+
+if (!version) {
+  console.log(`Usage: npm run version [version]`);
+  process.exit();
+}
+if (!VERSION_REGEXP.test(version)) {
+  console.error(`Illegal version: ${version}`);
+  process.exit(1);
+}
+
+const rootDir = join(__dirname, '..');
+//const VERSION_FILE_NAME = 'src/version.js';
+const PACKAGE_FILE_NAME = 'package.json';
+
+/*
+function writeVersionFile(path, version) {
+  const filePath = join(rootDir, path, VERSION_FILE_NAME);
+  if (existsSync(filePath)) {
+    writeFileSync(filePath, `export default '${version}';`);
+  }
+}
+*/
+
+function readPackageFileSync(path) {
+  const file = join(path, PACKAGE_FILE_NAME);
+  return existsSync(file) ? JSON.parse(readFileSync(file)) : undefined;
+}
+
+function writePackageFileSync(path, data) {
+  const file = join(path, PACKAGE_FILE_NAME);
+  if (!existsSync(file)) {
+    mkdirSync(dirname(file), { recursive: true });
+  }
+  writeFileSync(join(path, PACKAGE_FILE_NAME), JSON.stringify(data, null, 2));
+}
+
+const { name, version: _version, ...project } = readPackageFileSync(rootDir);
+writePackageFileSync(rootDir, { name, version, ...project });

package/cli/nodemon.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import { fileURLToPath } from 'url';
+import { dirname, resolve, join } from 'path';
+import nodemon from 'nodemon';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+nodemon({
+  script: resolve(__dirname, 'server.js'),
+  watch: join(__dirname, '../src'),
+  ext: 'js json yaml',
+  verbose: true,
+});
+
+nodemon.on('log', ({ colour }) => {
+  console.log(colour);
+});
+
+nodemon.on('quit', () => {
+  process.exit();
+});

package/cli/server.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import doggoganger from '../src/index.js';
+
+doggoganger();

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@miso.ai/doggoganger",
+  "version": "0.9.0-beta.2",
+  "description": "A dummy miso endpoint for demo and testing",
+  "type": "module",
+  "bin": {
+    "doggomon": "cli/nodemon.js",
+    "doggoganger": "cli/server.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "start": "nodemon src/index.js",
+    "version": "node ./bin/version.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MisoAI/miso-client-js-sdk.git"
+  },
+  "homepage": "https://misoai.github.io/miso-client-js-sdk/",
+  "license": "MIT",
+  "contributors": [
+    "simonpai <simon.pai@askmiso.com>"
+  ],
+  "bugs": {
+    "url": "https://github.com/MisoAI/miso-client-js-sdk/issues"
+  },
+  "dependencies": {
+    "@koa/cors": "^4.0.0",
+    "@koa/router": "^12.0.0",
+    "js-yaml": "^4.1.0",
+    "koa": "^2.14.1",
+    "koa-body": "^6.0.1",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "nodemon": "^2.0.15"
+  }
+}

package/src/api/answers.js

@@ -0,0 +1,117 @@
+import Router from '@koa/router';
+import { v4 as uuid } from 'uuid';
+import { lorem, articles, utils } from '../data/index.js';
+
+const router = new Router();
+
+const WPS = 20;
+const ITEMS_LOADING_TIME = 3;
+const STAGES = [
+  {
+    duration: 1.5,
+    text: `Fetching results...`,
+  },
+  {
+    duration: 1.5,
+    text: `Generating answer...`,
+  }
+];
+
+function formatDatetime(timestamp) {
+  const str = new Date(timestamp).toISOString();
+  return str.endsWith('Z') ? str.slice(0, -1) : str;
+}
+
+const answers = new Map();
+
+class Answer {
+
+  constructor(question, previous_question_id) {
+    this.question_id = uuid();
+    this.question = question;
+    this.previous_answer_id = previous_question_id;
+    this.timestamp = Date.now();
+    this.datetime = formatDatetime(this.timestamp);
+
+    this.answer = lorem.lorem({
+      min: 50,
+      max: 100,
+      decorates: ['description'],
+      output: 'array',
+    });
+    this.relatedResources = [...articles({ rows: utils.randomInt(6, 8) })];
+    this.sources = [...articles({ rows: utils.randomInt(4, 6) })];
+
+    this.previous_question_id = previous_question_id && answers.get(previous_question_id) || undefined;
+    answers.set(this.question_id, this);
+  }
+
+  get() {
+    const now = Date.now();
+    const elapsed = (now - this.timestamp) / 1000;
+    const [answer, finished] = this._answer(elapsed);
+    const sources = this._sources(elapsed);
+    const related_resources = this._relatedResources(elapsed);
+    const { question_id, question, datetime, previous_question_id } = this;
+
+    return {
+      affiliation: undefined,
+      answer,
+      datetime,
+      finished,
+      previous_question_id,
+      question,
+      question_id,
+      related_resources,
+      sources,
+    };
+  }
+
+  _answer(elapsed) {
+    for (const stage of STAGES) {
+      elapsed -= stage.duration;
+      if (elapsed < 0) {
+        return [stage.text, false];
+      }
+    }
+    const wordCount = Math.floor(elapsed * WPS);
+    const finished = wordCount >= this.answer.length;
+    const text = (finished ? this.answer : this.answer.slice(0, wordCount)).join(' ');
+    return [text, finished];
+  }
+
+  _sources(elapsed) {
+    const { sources } = this;
+    const { length } = sources;
+    const loaded = Math.floor(length * elapsed / ITEMS_LOADING_TIME);
+    return sources.slice(0, loaded);
+  }
+
+  _relatedResources(elapsed) {
+    const { relatedResources } = this;
+    const { length } = relatedResources;
+    const loaded = Math.floor(length * elapsed / ITEMS_LOADING_TIME);
+    return relatedResources.slice(0, loaded);
+  }
+
+}
+
+router.post('/questions', (ctx) => {
+  const { q: question, previous_answer_id } = JSON.parse(ctx.request.body);
+  const answer = new Answer(question, previous_answer_id);
+  const data = answer.get();
+  ctx.body = JSON.stringify({ data });
+});
+
+router.get('/questions/:id/answer', (ctx) => {
+  const { id } = ctx.params;
+  const answer = answers.get(id);
+  if (!answer) {
+    ctx.status = 404;
+  } else {
+    const data = answer.get();
+    ctx.body = JSON.stringify({ data });
+  }
+});
+
+export default router;

package/src/api/handlers.js

@@ -0,0 +1,10 @@
+import { products as _products } from '../data/index.js';
+
+export function products(ctx) {
+  const { rows = 5 } = JSON.parse(ctx.request.body);
+  ctx.body = {
+    data: {
+      products: [..._products({ rows })],
+    },
+  };
+}

package/src/api/index.js

@@ -0,0 +1,18 @@
+import Router from '@koa/router';
+import answers from './answers.js';
+import recommendation from './recommendation.js';
+import search from './search.js';
+import interactions from './interactions.js';
+
+function use(router, path, middleware) {
+  router.use(path, middleware.routes(), middleware.allowedMethods());
+}
+
+const router = new Router();
+
+use(router, '/answers', answers);
+use(router, '/recommendation', recommendation);
+use(router, '/search', search);
+use(router, '/interactions', interactions);
+
+export default router;

package/src/api/interactions.js

@@ -0,0 +1,9 @@
+import Router from '@koa/router';
+
+const router = new Router();
+
+router.post('/', (ctx) => {
+  ctx.body = { took: 1, errors: false, data: [] };
+});
+
+export default router;

package/src/api/recommendation.js

@@ -0,0 +1,9 @@
+import Router from '@koa/router';
+import { products } from './handlers.js';
+
+const router = new Router();
+
+router.post('/user_to_products', products);
+router.post('/product_to_products', products);
+
+export default router;

package/src/api/search.js

@@ -0,0 +1,8 @@
+import Router from '@koa/router';
+import { products } from './handlers.js';
+
+const router = new Router();
+
+router.post('/search', products);
+
+export default router;

package/src/data/articles.js

@@ -0,0 +1,47 @@
+import * as u from './utils.js';
+import * as lorem from './lorem.js';
+
+export function *articles({ rows, ...options } = {}) {
+  for (let i = 0; i < rows; i++) {
+    yield article({ ...options, index: i });
+  }
+}
+
+function article({} = {}) {
+  const id = u.id();
+  const prices = u.repeat(u.price, 1, 2);
+  prices.sort();
+  const seed = Math.floor(Math.random() * 1000);
+
+  return {
+    product_id: id,
+    authors: lorem.lorem({
+      min: 1,
+      max: 3,
+      fixedStarts: 0,
+      decorates: ['title'],
+      output: 'array',
+    }),
+    categories: [],
+    tags: lorem.lorem({
+      min: 1,
+      max: 4,
+      fixedStarts: 0,
+      output: 'array',
+    }),
+    title: lorem.lorem({
+      min: 4,
+      max: 10,
+      fixedStarts: 0,
+      decorates: ['title'],
+    }),
+    description: lorem.lorem({
+      min: 20,
+      max: 40,
+      decorates: ['description'],
+    }),
+    //html,
+    cover_image: `https://picsum.photos/seed/${seed}/300`,
+    url: `/products/${id}`,
+  };
+}

package/src/data/index.js

@@ -0,0 +1,4 @@
+export * as lorem from './lorem.js';
+export * from './products.js';
+export * from './articles.js';
+export * as utils from './utils.js';

package/src/data/lorem.js

@@ -0,0 +1,112 @@
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, resolve } from 'path';
+import yaml from 'js-yaml';
+import { randomInt } from './utils.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const DEFAULT_WORDS = yaml.load(readFileSync(resolve(__dirname, './words.yaml'), 'utf8'));
+
+export function lorem({ decorates = [], min, max, n, output = 'string', ...options } = {}) {
+  let iterator = limit({ min, max, n })(base(options));
+  for (const decorate of decorates) {
+    iterator = lookup(decorate)(iterator);
+  }
+  return lookup(output)(iterator);
+}
+
+const FNS = {
+  string,
+  array,
+  title,
+  description,
+}
+
+function lookup(fn) {
+  return typeof fn === 'string' ? FNS[fn]() : fn();
+}
+
+// base //
+export function *base({ words = DEFAULT_WORDS, fixedStarts = 2 } = {}) {
+  const wordsLength = words.length;
+  for (let i = 0; ; i++) {
+    yield words[i < fixedStarts ? i : Math.floor(Math.random() * wordsLength)];
+  }
+}
+
+// output //
+export function string({ separator = ' ' } = {}) {
+  return iterator => [...iterator].join(separator);
+}
+
+export function array() {
+  return iterator => [...iterator];
+}
+
+// decorators //
+export function limit({ n, min = 5, max = 10 }) {
+  n = n || randomInt(min, max);
+  return function *(iterator) {
+    let i = 0;
+    for (let word of iterator) {
+      if (i++ >= n) {
+        break;
+      }
+      yield word;
+    }
+  };
+}
+
+export function title({} = {}) {
+  return function *(iterator) {
+    for (let word of iterator) {
+      yield capitalize(word);
+    }
+  };
+}
+
+export function description({
+  wordsPerSentenceAvg = 24,
+  wordsPerSentenceStd = 5,
+} = {}) {
+  return function *(iterator) {
+    let word;
+    let slen = 0;
+    for (let _word of iterator) {
+      if (word) {
+        yield word;
+      }
+      word = _word;
+      if (slen === 0) {
+        word = capitalize(word);
+        slen = Math.max(1, gaussMS(wordsPerSentenceAvg, wordsPerSentenceStd));
+      }
+      if (--slen === 0) {
+        word += '.';
+      }
+    }
+    if (word) {
+      if (!word.endsWith('.')) {
+        word += '.';
+      }
+      yield word;
+    }
+  };
+}
+
+// helpers //
+function capitalize(word) {
+  return word[0].toUpperCase() + word.substring(1);
+}
+
+function gaussMS(mean, std) {
+  return Math.round(gaussRandom() * std + mean);
+}
+
+function gaussRandom() {
+  return uniformRandom() + uniformRandom() + uniformRandom();
+}
+
+function uniformRandom() {
+  return Math.random() * 2 - 1;
+}

package/src/data/products.js

@@ -0,0 +1,51 @@
+import * as u from './utils.js';
+import * as lorem from './lorem.js';
+
+export function *products({ rows, ...options } = {}) {
+  for (let i = 0; i < rows; i++) {
+    yield product({ ...options, index: i });
+  }
+}
+
+function product({} = {}) {
+  const id = u.id();
+  const prices = u.repeat(u.price, 1, 2);
+  prices.sort();
+  const seed = Math.floor(Math.random() * 1000);
+
+  return {
+    product_id: id,
+    authors: lorem.lorem({
+      min: 1,
+      max: 3,
+      fixedStarts: 0,
+      decorates: ['title'],
+      output: 'array',
+    }),
+    categories: [],
+    tags: lorem.lorem({
+      min: 1,
+      max: 4,
+      fixedStarts: 0,
+      output: 'array',
+    }),
+    title: lorem.lorem({
+      min: 2,
+      max: 6,
+      fixedStarts: 0,
+      decorates: ['title'],
+    }),
+    description: lorem.lorem({
+      min: 10,
+      max: 20,
+      decorates: ['description'],
+    }),
+    //html,
+    cover_image: `https://picsum.photos/seed/${seed}/300`,
+    url: `/products/${id}`,
+    sale_price: prices[0],
+    original_price: prices[prices.length - 1],
+    rating: u.rating(),
+    availability: u.availability(),
+  };
+}

package/src/data/utils.js

@@ -0,0 +1,28 @@
+export function randomInt(min, max) {
+  return max > min ? min + Math.floor(Math.random() * (max - min)) : min;
+}
+
+export function repeat(fn, min = 1, max = 2) {
+  const n = randomInt(min, max);
+  const result = [];
+  for (let i = 0; i < n; i++) {
+    result.push(fn());
+  }
+  return result;
+}
+
+export function id() {
+  return Math.random().toString(36).substring(2, 10);
+}
+
+export function availability() {
+  return Math.random() > 0.3 ? 'IN_STOCK' : 'OUT_OF_STOCK';
+}
+
+export function price() {
+  return Math.floor(Math.random() * 10000) / 100;
+}
+
+export function rating() {
+  return Math.floor(Math.random() * 500) / 100 + 1;
+}

package/src/data/words.yaml

@@ -0,0 +1,178 @@
+- lorem
+- ipsum
+- dolor
+- sit
+- amet
+- consectetur
+- adipiscing
+- elit
+- curabitur
+- vel
+- hendrerit
+- libero
+- eleifend
+- blandit
+- nunc
+- ornare
+- odio
+- ut
+- orci
+- gravida
+- imperdiet
+- nullam
+- purus
+- lacinia
+- a
+- pretium
+- quis
+- congue
+- praesent
+- sagittis
+- laoreet
+- auctor
+- mauris
+- non
+- velit
+- eros
+- dictum
+- proin
+- accumsan
+- sapien
+- nec
+- massa
+- volutpat
+- venenatis
+- sed
+- eu
+- molestie
+- lacus
+- quisque
+- porttitor
+- ligula
+- dui
+- mollis
+- tempus
+- at
+- magna
+- vestibulum
+- turpis
+- ac
+- diam
+- tincidunt
+- id
+- condimentum
+- enim
+- sodales
+- in
+- hac
+- habitasse
+- platea
+- dictumst
+- aenean
+- neque
+- fusce
+- augue
+- leo
+- eget
+- semper
+- mattis
+- tortor
+- scelerisque
+- nulla
+- interdum
+- tellus
+- malesuada
+- rhoncus
+- porta
+- sem
+- aliquet
+- et
+- nam
+- suspendisse
+- potenti
+- vivamus
+- luctus
+- fringilla
+- erat
+- donec
+- justo
+- vehicula
+- ultricies
+- varius
+- ante
+- primis
+- faucibus
+- ultrices
+- posuere
+- cubilia
+- curae
+- etiam
+- cursus
+- aliquam
+- quam
+- dapibus
+- nisl
+- feugiat
+- egestas
+- class
+- aptent
+- taciti
+- sociosqu
+- ad
+- litora
+- torquent
+- per
+- conubia
+- nostra
+- inceptos
+- himenaeos
+- phasellus
+- nibh
+- pulvinar
+- vitae
+- urna
+- iaculis
+- lobortis
+- nisi
+- viverra
+- arcu
+- morbi
+- pellentesque
+- metus
+- commodo
+- ut
+- facilisis
+- felis
+- tristique
+- ullamcorper
+- placerat
+- aenean
+- convallis
+- sollicitudin
+- integer
+- rutrum
+- duis
+- est
+- etiam
+- bibendum
+- donec
+- pharetra
+- vulputate
+- maecenas
+- mi
+- fermentum
+- consequat
+- suscipit
+- aliquam
+- habitant
+- senectus
+- netus
+- fames
+- quisque
+- euismod
+- curabitur
+- lectus
+- elementum
+- tempor
+- risus
+- cras

package/src/index.js

@@ -0,0 +1,19 @@
+import Koa from 'koa';
+import Router from '@koa/router';
+import cors from '@koa/cors';
+import { koaBody } from 'koa-body';
+import api from './api/index.js';
+
+export default function doggoganger() {
+  const app = new Koa();
+  const router = new Router();
+  
+  router.use('/api', api.routes(), api.allowedMethods());
+  
+  app
+    .use(cors())
+    .use(koaBody())
+    .use(router.routes())
+    .use(router.allowedMethods())
+    .listen(9901);
+}