@miso.ai/server-shopify 0.6.3-beta.0

package/cli/index.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+import { yargs } from '@miso.ai/server-commons';
+import version from '../src/version.js';
+import store from './store/index.js';
+
+yargs.build(yargs => {
+  yargs
+    .env('MISO_SHOPIFY')
+    .option('shop', {
+      alias: ['s', 'domain'],
+      describe: 'the Shopify shop domain',
+    })
+    .option('token', {
+      alias: ['t'],
+      describe: 'Access token',
+    })
+    .option('api-version', {
+      describe: 'the Shopify API version',
+    })
+    .option('debug', {
+      type: 'boolean',
+      default: false,
+    })
+    .hide('debug')
+    .command(store)
+    .version(version);
+});

package/cli/store/index.js

@@ -0,0 +1,12 @@
+import products from './products.js';
+
+function build(yargs) {
+  return yargs
+    .command(products);
+}
+
+export default {
+  command: 'store',
+  desc: 'Shopify store APIs',
+  builder: build,
+};

package/cli/store/products.js

@@ -0,0 +1,63 @@
+import { stream } from '@miso.ai/server-commons';
+import { ShopifyStoreAdminClient } from '../../src/index.js';
+
+function build(yargs) {
+  return yargs
+    .option('count', {
+      alias: 'c',
+      describe: 'Count number of products',
+      type: 'boolean',
+    })
+    .option('limit', {
+      alias: 'n',
+      describe: 'Limit number of products to fetch',
+      type: 'number',
+    })
+    .option('ids', {
+      describe: 'Retrieve products by IDs',
+    })
+    .array('ids')
+    .coerce('ids', value => value.flatMap(v => `${v}`.split(',').map(v => v.trim())))
+    .option('explain', {
+      describe: 'Explain the query',
+      type: 'boolean',
+    });
+}
+
+async function run({ explain, count, ...options }) {
+  if (explain) {
+    await runExplain({ count, ...options });
+  } else if (count) {
+    await runCount(options);
+  } else {
+    await runList(options);
+  }
+}
+
+async function runCount(options) {
+  const client = new ShopifyStoreAdminClient(options);
+  const count = await client.products.count();
+  console.log(count);
+}
+
+async function runList(options) {
+  const client = new ShopifyStoreAdminClient(options);
+  await stream.pipeline(
+    client.products.stream(options),
+    new stream.OutputStream({
+      objectMode: true,
+    }),
+  );
+}
+
+async function runExplain(options) {
+  const client = new ShopifyStoreAdminClient(options);
+  console.log(await client.products.explain(options));
+}
+
+export default {
+  command: 'products',
+  desc: 'Shopify store products APIs',
+  builder: build,
+  handler: run,
+};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@miso.ai/server-shopify",
+  "description": "Miso Shopify API data tools",
+  "type": "module",
+  "main": "src/index.js",
+  "bin": {
+    "miso-shopify": "cli/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {},
+  "repository": "MisoAI/miso-server-js-sdk",
+  "license": "MIT",
+  "contributors": [
+    "simonpai <simon.pai@askmiso.com>"
+  ],
+  "dependencies": {
+    "@miso.ai/server-commons": "0.6.3-beta.0",
+    "axios": "^0.27.2",
+    "axios-retry": "^3.3.1"
+  },
+  "version": "0.6.3-beta.0"
+}

package/src/index.js

@@ -0,0 +1 @@
+export * from './store/index.js';

package/src/store/client.js

@@ -0,0 +1,14 @@
+import { defineValues } from '@miso.ai/server-commons';
+import Core from './core.js';
+import Products from './products.js';
+
+export default class ShopifyStoreAdminClient {
+
+  constructor(options) {
+    const core = this._core = new Core(options);
+    defineValues(this, {
+      products: new Products(core),
+    });
+  }
+
+}

package/src/store/core.js

@@ -0,0 +1,168 @@
+import { Readable, Transform } from 'stream';
+import axios from 'axios';
+import axiosRetry from 'axios-retry';
+import { defineValues, trimObj } from '@miso.ai/server-commons';
+
+// const STREAM_OPTIONS = ['limit'];
+
+export default class Core {
+
+  constructor(options = {}) {
+    const { shop, apiVersion = '2022-10', token, timeout = 5000 } = this._options = options;
+    const baseUrl = `https://${shop}.myshopify.com/admin/api/${apiVersion}`;
+    defineValues(this, {
+      baseUrl,
+    });
+    this._axios = axios.create({
+      baseURL: baseUrl,
+      timeout,
+      headers: {
+        'Content-Type': 'application/json',
+        'X-Shopify-Access-Token': token,
+      },
+    });
+    axiosRetry(this._axios, {
+      retries: 5,
+      retryDelay: count => count * 300,
+    });
+    this._start = Date.now();
+    this.debug = this.debug.bind(this);
+  }
+
+  async fetch(path, options = {}) {
+    const { method = 'GET', body, params } = options;
+    const { status, data, headers } = await this._axios.request({
+      url: path,
+      method,
+      params,
+      data: body,
+    });
+    // TODO: handle status
+    const {
+      'x-shopify-shop-api-call-limit': callLimit,
+      link,
+    } = headers;
+    const pageInfo = parseLink(link);
+    //this.debug({ path, params, status, pageInfo, callLimit, link });
+    return trimObj({ data, pageInfo, callLimit });
+  }
+
+  async explain(resource, { count, ids } = {}) {
+    const { baseURL, headers = {} } = this._axios.defaults;
+    const path = count ? `/${resource}/count.json` : `/${resource}.json`;
+    const params = trimObj({
+      ids: encodeIds(ids),
+    });
+    const headersOptions = Object.entries(headers).map(([k, v]) => typeof v === 'string' ? ` -H '${k}: ${v}'` : '').join('');
+    const paramsStr = `${new URLSearchParams(params)}`;
+    const url = `${baseURL}${path}${paramsStr ? `?${paramsStr}` : ''}`;
+    return `curl${headersOptions} '${url}'`;
+  }
+
+  async count(resource) {
+    return (await this.fetch(`/${resource}/count.json`)).data.count;
+  }
+
+  stream(resource, options) {
+    return new ShopifyStoreResourceStream(this, resource, options)
+      .pipe(new FlatmapStream());
+  }
+
+  debug(v) {
+    if (this._options.debug) {
+      const elapsed = (Date.now() - this._start) / 1000;
+      console.error(`[${elapsed}]`, v);
+    }
+  }
+
+}
+
+function parseLink(link) {
+  if (!link) {
+    return undefined;
+  }
+  return link.split(',').reduce((acc, line) => {
+    try {
+      const [url, rel] = line.trim().split('; rel=');
+      if (rel) {
+        const pageInfo = new URL(url.slice(1, -1)).searchParams.get('page_info');
+        if (pageInfo) {
+          acc[rel.slice(1, -1)] = pageInfo;
+        }
+      }
+    } catch(e) {}
+    return acc;
+  }, {});
+}
+
+function encodeIds(ids) {
+  return ids && ids.map(s => s.trim()).join(',');
+}
+
+// TODO: move to server-commons
+class FlatmapStream extends Transform {
+
+  constructor() {
+    super({ objectMode: true });
+  }
+
+  async _transform(records, _, next) {
+    for (const record of records) {
+      this.push(record);
+    }
+    next();
+  }
+
+}
+
+class ShopifyStoreResourceStream extends Readable {
+
+  constructor(core, resource, { ids, limit, pageSize = 200 }) {
+    super({ objectMode: true });
+    this._core = core;
+    this._resource = resource;
+    this._pageSize = pageSize;
+    this._remaining = limit;
+    this._params = trimObj({
+      ids: encodeIds(ids),
+    });
+  }
+
+  async _read() {
+    if (this._done) {
+      this.push(null);
+      return;
+    }
+    const limit = this._remaining !== undefined ? Math.min(this._remaining, this._pageSize) : this._pageSize;
+    const params = trimObj({
+      ...this._params,
+      limit,
+      page_info: this._pageInfo,
+    });
+    const { data, pageInfo } = await this._core.fetch(`/${this._resource}.json`, { params });
+    if (pageInfo && pageInfo.next) {
+      this._pageInfo = pageInfo.next;
+    } else {
+      this._done = true;
+    }
+    let { [this._resource]: records } = data;
+    const size = records.length;
+    if (this._remaining !== undefined) {
+      this._remaining -= size;
+      if (this._remaining <= 0) {
+        this._done = true;
+      }
+    }
+    if (size < limit) {
+      this._done = true;
+    } else if (size > limit) {
+      records = records.slice(0, limit); // just in case
+    }
+    this.push(size > 0 ? records : null);
+  }
+
+  _debug(...args) {
+    this._core.debug(...args);
+  }
+
+}

package/src/store/index.js

@@ -0,0 +1 @@
+export { default as ShopifyStoreAdminClient } from './client.js';

package/src/store/products.js

@@ -0,0 +1,19 @@
+export default class Products {
+
+  constructor(core) {
+    this._core = core;
+  }
+  
+  async explain(options) {
+    return this._core.explain('products', options);
+  }
+
+  async count() {
+    return this._core.count('products');
+  }
+
+  stream(options) {
+    return this._core.stream('products', options);
+  }
+
+}

package/src/version.js

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