@miso.ai/server-sdk 0.6.3-beta.9 → 0.6.4-beta.0

package/cli/get.js

@@ -0,0 +1,23 @@
+import { MisoClient } from '../src/index.js';
+
+const build = yargs => yargs;
+
+const run = type => async ({
+  key,
+  server,
+  id,
+  debug,
+}) => {
+  const client = new MisoClient({ key, server });
+  const entity = await client.api[type].get(id);
+  console.log(JSON.stringify(entity));
+};
+
+export default function(type) {
+  return {
+    command: 'get [id]',
+    description: `Get ${type}`,
+    builder: build,
+    handler: run(type),
+  };
+}

package/cli/index.js

@@ -1,17 +1,20 @@
 #!/usr/bin/env node
 import { yargs } from '@miso.ai/server-commons';
 import { MisoClient } from '../src/index.js';
+import { buildForApi } from './utils.js';
+import merge from './merge.js';
 import upload from './upload.js';
 import del from './delete.js';
 import ids from './ids.js';
 import transform from './transform.js';
 import status from './status.js';
+import get from './get.js';
 
 const interactions = {
   command: 'interactions',
   aliases: ['interaction', 'i'],
   description: 'Interaction commands',
-  builder: yargs => _buildForApi(yargs)
+  builder: yargs => buildForApi(yargs)
     .command(upload('interactions')),
 };
 
@@ -19,10 +22,12 @@ const products = {
   command: 'products',
   aliases: ['product', 'p', 'catalog'],
   description: 'Product commands',
-  builder: yargs => _buildForApi(yargs)
+  builder: yargs => buildForApi(yargs)
     .command(upload('products'))
     .command(del('products'))
     .command(ids('products'))
+    .command(get('products'))
+    .command(merge('products'))
     .command(status('products')),
 };
 
@@ -30,10 +35,12 @@ const users = {
   command: 'users',
   aliases: ['user', 'u'],
   description: 'User commands',
-  builder: yargs => _buildForApi(yargs)
+  builder: yargs => buildForApi(yargs)
     .command(upload('users'))
     .command(del('users'))
     .command(ids('users'))
+    .command(get('users'))
+    .command(merge('users'))
     .command(status('users')),
 };
 
@@ -41,7 +48,7 @@ const experiments = {
   command: 'experiments',
   aliases: ['experiment'],
   description: 'Experiment commands',
-  builder: yargs => _buildForApi(yargs)
+  builder: yargs => buildForApi(yargs)
     .option('experiment-id', {
       alias: ['exp-id'],
       describe: 'Experiment ID for experiment API',
@@ -63,29 +70,3 @@ yargs.build(yargs => {
     .command(transform)
     .version(MisoClient.version);
 });
-
-
-
-// helpers //
-function _buildForApi(yargs) {
-  return yargs
-    .option('key', {
-      alias: ['k', 'api-key'],
-      describe: 'API key',
-    })
-    .option('server', {
-      alias: ['api-server'],
-      describe: 'API server',
-    })
-    .option('param', {
-      alias: ['v', 'var'],
-      describe: 'Extra URL parameters',
-      type: 'array',
-      coerce: yargs.coerceToArray,
-    })
-    .option('debug', {
-      describe: 'Set log level to debug',
-      type: 'boolean',
-    })
-    .demandOption(['key'], 'API key is required.');
-}

package/cli/merge.js

@@ -0,0 +1,39 @@
+import split2 from 'split2';
+import { stream } from '@miso.ai/server-commons';
+import { MisoClient } from '../src/index.js';
+
+function build(yargs) {
+  return yargs
+    .option('file', {
+      alias: ['f'],
+      describe: 'File that contains the merge function',
+    });
+}
+
+const run = type => async ({
+  key,
+  server,
+  file,
+  ...options
+}) => {
+  // TODO: load merge function
+  const client = new MisoClient({ key, server });
+  const mergeStream = client.api[type].mergeStream(options);
+  const outputStream = new stream.OutputStream({ objectMode: true });
+  await stream.pipeline(
+    process.stdin,
+    split2(),
+    stream.parse(),
+    mergeStream,
+    outputStream
+  );
+}
+
+export default function(type) {
+  return {
+    command: 'merge',
+    description: `Merge records with existing ${type} in catalog.`,
+    builder: build,
+    handler: run(type),
+  };
+}

package/cli/utils.js

@@ -0,0 +1,22 @@
+export function buildForApi(yargs) {
+  return yargs
+    .option('key', {
+      alias: ['k', 'api-key'],
+      describe: 'API key',
+    })
+    .option('server', {
+      alias: ['api-server'],
+      describe: 'API server',
+    })
+    .option('param', {
+      alias: ['v', 'var'],
+      describe: 'Extra URL parameters',
+      type: 'array',
+      coerce: yargs.coerceToArray,
+    })
+    .option('debug', {
+      describe: 'Set log level to debug',
+      type: 'boolean',
+    })
+    .demandOption(['key'], 'API key is required.');
+}

package/package.json

@@ -16,11 +16,11 @@
     "simonpai <simon.pai@askmiso.com>"
   ],
   "dependencies": {
-    "@miso.ai/server-commons": "0.6.3-beta.9",
-    "axios": "^0.27.2",
+    "@miso.ai/server-commons": "0.6.4-beta.0",
+    "axios": "^1.6.2",
     "dotenv": "^16.0.1",
     "split2": "^4.1.0",
     "yargs": "^17.5.1"
   },
-  "version": "0.6.3-beta.9"
+  "version": "0.6.4-beta.0"
 }

package/src/api/base.js

@@ -1,8 +1,10 @@
 import axios from 'axios';
-import { upload, batchDelete, buildUrl } from './helpers.js';
+import { asArray } from '@miso.ai/server-commons';
+import { upload, merge, batchDelete, buildUrl } from './helpers.js';
 import UploadStream from '../stream/upload.js';
 import DeleteStream from '../stream/delete.js';
 import StatusStream from '../stream/status.js';
+import MergeStream from '../stream/merge.js';
 
 export class Queries {
 
@@ -69,4 +71,13 @@ export class Entities extends Writable {
     return new StatusStream(this._client, this._type);
   }
 
+  async merge(records, options = {}) {
+    records = asArray(records);
+    return await Promise.all(records.map(record => merge(this._client, this._type, record, options)));
+  }
+
+  mergeStream(options = {}) {
+    return new MergeStream(this._client, this._type, options);
+  }
+
 }

package/src/api/helpers.js

@@ -8,6 +8,46 @@ export async function upload(client, type, records, options = {}) {
   return axios.post(url, payload);
 }
 
+export async function merge(client, type, record, { mergeFn = defaultMerge } = {}) {
+  let idProp;
+  switch (type) {
+    case 'products':
+      idProp = 'product_id';
+      break;
+    case 'users':
+      idProp = 'user_id';
+      break;
+    default:
+      throw new Error(`Unsupported type: ${type}`);
+  }
+  const id = record[idProp];
+  if (!id) {
+    throw new Error(`Record missing ${idProp}.`);
+  }
+  const base = shimRecordForMerging(await client.api[type].get(id));
+  return await mergeFn(base, record);
+}
+
+function defaultMerge(base, patch) {
+  return {
+    ...base,
+    ...patch,
+    custom_attributes: {
+      ...base.custom_attributes,
+      ...patch.custom_attributes,
+    },
+  };
+}
+
+function shimRecordForMerging(record) {
+  for (const key in record) {
+    if (key === 'product_group_id_or_product_id' || key.startsWith('category_path_')) {
+      delete record[key];
+    }
+  }
+  return record;
+}
+
 const RE_422_MSG_LINE = /^\s*data\.(\d+)(?:\.(\S+))?\s+is\s+invalid\.\s+(.*)$/;
 
 export function process422ResponseBody(payload, { data } = {}) {

package/src/api/index.js

@@ -1,9 +1,12 @@
+import { asArray } from '@miso.ai/server-commons';
+import { merge } from './helpers.js';
 import Products from './products.js';
 import Users from './users.js';
 import Interactions from './interactions.js';
 import Experiments from './experiments.js';
 import Search from './search.js';
 import Recommendation from './recommendation.js';
+import MergeStream from '../stream/merge.js';
 
 export default class Api {
 

package/src/logger/index.js

@@ -11,7 +11,7 @@ export function createLogStream({
   format,
   out,
   err,
-}) {
+} = {}) {
   switch (format || FORMAT.JSON) {
     case FORMAT.PROGRESS:
       switch (api) {

package/src/normalize/index.js

@@ -63,7 +63,7 @@ export class Stream extends Transform {
     this._transformFn = getTransformFunction(type);
   }
 
-  async _transform(record, _, next) {
+  _transform(record, _, next) {
     try {
       next(undefined, this._transformFn(record));
     } catch (error) {

package/src/stream/merge.js

@@ -0,0 +1,22 @@
+import { stream } from '@miso.ai/server-commons';
+import { merge } from '../api/helpers.js';
+
+export default class MergeStream extends stream.ParallelTransform {
+
+  constructor(client, type, {
+    mergeFn,
+  } = {}) {
+    super({
+      transform: (record) => merge(client, type, record, { mergeFn }),
+      controls: {
+        throttle: 100,
+      },
+      objectMode: true,
+    });
+  }
+
+  _error(error) {
+    console.error(error);
+  }
+
+}

package/src/stream/status.js

@@ -10,7 +10,7 @@ export default class StatusStream extends Transform {
     this._type = type;
   }
 
-  async _transform(task_id, _) {
+  async _transform(task_id, _, next) {
     try {
       this.push({
         task_id,
@@ -23,6 +23,7 @@ export default class StatusStream extends Transform {
         error: summarizeError(err),
       });
     }
+    next();
   }
 
 }

package/src/version.js

@@ -1 +1 @@
-export default '0.6.3-beta.9';
+export default '0.6.4-beta.0';