@miso.ai/server-sdk 0.6.5-beta.7 → 0.6.5-beta.8

package/cli/delete.js

@@ -49,7 +49,7 @@ const run = type => async ({
   loglevel = (debug || progress) ? log.DEBUG : loglevel;
   logFormat = progress ? logger.FORMAT.PROGRESS : logFormat;
 
-  const client = new MisoClient({ key, server });
+  const client = new MisoClient({ key, server, debug });
 
   const deleteStream = client.api[type].deleteStream({
     name,

package/cli/get.js

@@ -1,4 +1,5 @@
 import { MisoClient } from '../src/index.js';
+import { formatError } from './utils.js';
 
 const build = yargs => yargs;
 
@@ -8,9 +9,13 @@ const run = type => async ({
   id,
   debug,
 }) => {
-  const client = new MisoClient({ key, server });
-  const entity = await client.api[type].get(id);
-  console.log(JSON.stringify(entity));
+  const client = new MisoClient({ key, server, debug });
+  try {
+    const entity = await client.api[type].get(id);
+    console.log(JSON.stringify(entity));
+  } catch (err) {
+    console.error(formatError(err));
+  }
 };
 
 export default function(type) {

package/cli/hybrid-search.js

@@ -0,0 +1,36 @@
+import { Readable } from 'stream';
+import { stream } from '@miso.ai/server-commons';
+import { MisoClient } from '../src/index.js';
+import { buildForApi, buildForSearch } from './utils.js';
+
+function build(yargs) {
+  return buildForSearch(buildForApi(yargs))
+    .positional('query', {
+      describe: 'Search query',
+    })
+    .option('answer', {
+      type: 'boolean',
+      describe: 'Return answer',
+      default: false,
+    });
+}
+
+async function run({ query, fq, fl, rows, answer, key, server, debug }) {
+  const client = new MisoClient({ key, server, debug });
+  const { products } = await client.api.ask.search({ q: query, fq, fl, rows, answer });
+  const readStream = Readable.from(products);
+  const outputStream = new stream.OutputStream();
+
+  await stream.pipeline(
+    readStream,
+    outputStream,
+  );
+}
+
+export default {
+  command: 'hybrid-search [query]',
+  aliases: ['hs'],
+  description: `Hybrid search records by a query.`,
+  builder: build,
+  handler: run,
+};

package/cli/ids-diff.js

@@ -30,10 +30,11 @@ const run = type => async ({
   output,
   plus,
   minus,
+  debug,
 }) => {
   output = output || (plus ? 'plus' : minus ? 'minus' : undefined);
 
-  const client = new MisoClient({ key, server });
+  const client = new MisoClient({ key, server, debug });
   const misoIds = await client.api[type].ids();
 
   const diffStream = new stream.DiffStream(misoIds, { output });

package/cli/ids.js

@@ -22,8 +22,9 @@ const run = type => async ({
   key,
   server,
   type: recordType,
+  debug,
 }) => {
-  const client = new MisoClient({ key, server });
+  const client = new MisoClient({ key, server, debug });
   let ids;
   try {
     const options = recordType ? { type: recordType } : {};
@@ -45,7 +46,7 @@ const run = type => async ({
 export default function(type) {
   return {
     command: 'ids',
-    description: false,
+    description: `Get all ids in the catalog`,
     builder: build(type),
     handler: run(type),
   };

package/cli/index.js

@@ -9,6 +9,8 @@ import ids from './ids.js';
 import transform from './transform.js';
 import status from './status.js';
 import get from './get.js';
+import search from './search.js';
+import hybridSearch from './hybrid-search.js';
 
 const interactions = {
   command: 'interactions',
@@ -68,5 +70,7 @@ yargs.build(yargs => {
     .command(users)
     .command(experiments)
     .command(transform)
+    .command(search)
+    .command(hybridSearch)
     .version(MisoClient.version);
 });

package/cli/merge.js

@@ -27,11 +27,12 @@ const run = type => async ({
   server,
   file,
   base,
+  debug,
   ...options
 }) => {
   const mergeFn = await getMergeFn(file);
   const records = await buildBaseRecords(base);
-  const client = new MisoClient({ key, server });
+  const client = new MisoClient({ key, server, debug });
   const mergeStream = client.api[type].mergeStream({ ...options, mergeFn, records });
   const outputStream = new stream.OutputStream({ objectMode: true });
   await stream.pipeline(

package/cli/search.js

@@ -0,0 +1,30 @@
+import { Readable } from 'stream';
+import { stream } from '@miso.ai/server-commons';
+import { MisoClient } from '../src/index.js';
+import { buildForApi, buildForSearch } from './utils.js';
+
+function build(yargs) {
+  return buildForSearch(buildForApi(yargs))
+    .positional('query', {
+      describe: 'Search query',
+    });
+}
+
+async function run({ query, fq, fl, rows, key, server, debug }) {
+  const client = new MisoClient({ key, server, debug });
+  const records = await client.api.search.search({ q: query, fq, fl, rows });
+  const readStream = Readable.from(records);
+  const outputStream = new stream.OutputStream();
+
+  await stream.pipeline(
+    readStream,
+    outputStream,
+  );
+}
+
+export default {
+  command: 'search [query]',
+  description: `Search records by a query.`,
+  builder: build,
+  handler: run,
+};

package/cli/status.js

@@ -10,8 +10,9 @@ const run = type => async ({
   key,
   server,
   taskId,
+  debug,
 }) => {
-  const client = new MisoClient({ key, server });
+  const client = new MisoClient({ key, server, debug });
   if (taskId) {
     runOne(client, type, taskId);
   } else {
@@ -21,7 +22,7 @@ const run = type => async ({
 
 async function runOne(client, type, taskId) {
   try {
-    console.log(await client.api[type].status(taskId));
+    console.log(JSON.stringify(await client.api[type].status(taskId)));
   } catch (err) {
     console.error(err);
     throw err;

package/cli/upload.js

@@ -61,7 +61,7 @@ const run = type => async ({
   loglevel = (debug || progress) ? log.DEBUG : loglevel;
   logFormat = progress ? logger.FORMAT.PROGRESS : logFormat;
 
-  const client = new MisoClient({ key, server });
+  const client = new MisoClient({ key, server, debug });
 
   const uploadStreamObjectMode = lenient;
 

package/cli/utils.js

@@ -20,3 +20,35 @@ export function buildForApi(yargs) {
     })
     .demandOption(['key'], 'API key is required.');
 }
+
+export function buildForSearch(yargs) {
+  return yargs
+    .option('fq', {
+      type: 'string',
+      describe: 'Filter query',
+    })
+    .option('fl', {
+      type: 'array',
+      coerce: yargs.coerceToArray,
+      describe: 'Fields to return',
+    })
+    .option('rows', {
+      alias: ['n'],
+      type: 'number',
+      describe: 'Number of rows to return',
+    })
+    .option('start', {
+      alias: ['s'],
+      type: 'number',
+      describe: 'Start index',
+    });
+}
+
+export function formatError(err) {
+  const { response } = err;
+  if (response) {
+    const { data, status } = response;
+    return { errors: true, status, ...data };
+  }
+  return { errors: true, message: err.message };
+}

package/package.json

@@ -16,12 +16,12 @@
     "simonpai <simon.pai@askmiso.com>"
   ],
   "dependencies": {
-    "@miso.ai/server-commons": "0.6.5-beta.7",
+    "@miso.ai/server-commons": "0.6.5-beta.8",
     "axios": "^1.6.2",
     "axios-retry": "^4.5.0",
     "dotenv": "^16.0.1",
     "split2": "^4.1.0",
     "yargs": "^17.5.1"
   },
-  "version": "0.6.5-beta.7"
+  "version": "0.6.5-beta.8"
 }

package/src/api/ask.js

@@ -0,0 +1,13 @@
+import { Queries } from './base.js';
+
+export default class Ask extends Queries {
+
+  constructor(client) {
+    super(client, 'ask');
+  }
+
+  async search(payload, options = {}) {
+    return this._run('search', payload, options);
+  }
+
+}

package/src/api/index.js

@@ -2,6 +2,7 @@ import Products from './products.js';
 import Users from './users.js';
 import Interactions from './interactions.js';
 import Experiments from './experiments.js';
+import Ask from './ask.js';
 import Search from './search.js';
 import Recommendation from './recommendation.js';
 
@@ -12,6 +13,7 @@ export default class Api {
     this.users = new Users(client);
     this.interactions = new Interactions(client);
     this.experiments = new Experiments(client);
+    this.ask = new Ask(client);
     this.search = new Search(client);
     this.recommendation = new Recommendation(client);
   }

package/src/axios.js

@@ -11,17 +11,33 @@ const DEFAULT_RETRY_OPTIONS = {
   },
 };
 
-export function createAxios(options = {}) {
+export function createAxios(options = {}, debug = false) {
   if (typeof options.get === 'function' && typeof options.post === 'function') {
     return options; // assume this is an axios instance already
   }
   const { retry } = options;
   const instance = axios.create({
     headers: {
-      'User-Agent': `MisoNodeJSSDK/${version}`,
+      'User-Agent': `MisoNodeSDK/${version}`,
       'Content-Type': 'application/json',
     },
   });
   axiosRetry(instance, { ...DEFAULT_RETRY_OPTIONS, ...retry });
+  if (debug) {
+    instance.interceptors.request.use(config => {
+      explainAsCurl(config);
+      return config;
+    });
+  }
   return instance;
 }
+
+function explainAsCurl(config) {
+  // format into a curl command
+  const { method, url, data } = config;
+  let command = `curl -X ${method.toUpperCase()} '${url}'`;
+  if (data) {
+    command += ` -d '${typeof data === 'string' ? data : JSON.stringify(data)}'`;
+  }
+  console.log(`[Explain] ${command}`);
+}

package/src/client.js

@@ -8,7 +8,7 @@ export default class MisoClient {
 
   constructor(options = {}) {
     this._options = options = normalizeOptions(options);
-    this._axios = createAxios(options.axios); // TODO: pass onRetry() for debug message
+    this._axios = createAxios(options.axios, options.debug); // TODO: pass onRetry() for debug message
     this.version = version;
     this.api = new Api(this);
   }

package/src/version.js

@@ -1 +1 @@
-export default '0.6.5-beta.7';
+export default '0.6.5-beta.8';