@miso.ai/server-wordpress 0.6.3-beta.0 → 0.6.3-beta.2

package/cli/entities.js

@@ -1,3 +1,4 @@
+import { Transform } from 'stream';
 import { stream, parseDuration } from '@miso.ai/server-commons';
 import { WordPressClient } from '../src/index.js';
 import { normalizeOptions, normalizeTransform, parseDate } from './utils.js';
@@ -34,6 +35,11 @@ export function buildForEntities(yargs) {
       alias: 'include',
       describe: 'Specify post ids'
     })
+    .option('fields', {
+      describe: 'Specify which record fields are retrieved',
+      type: 'array',
+      coerce: yargs.coerceToArray,
+    })
     .option('resolve', {
       alias: 'r',
       describe: 'Attach resolved entities (author, catagories) linked with the subjects',
@@ -60,9 +66,17 @@ function build(yargs) {
     });
 }
 
-async function run({ count, terms, update, name, ...options }) {
+async function run({ subcmd, count, terms, update, name, ...options }) {
   options = normalizeOptions(options);
   const client = new WordPressClient(options);
+  switch (subcmd) {
+    case 'ids':
+      await runIds(client, name, { update, ...options });
+      return;
+    case 'count':
+      await runCount(client, name, options);
+      return;
+  }
   if (count) {
     await runCount(client, name, options);
   } else if (terms) {
@@ -95,46 +109,71 @@ export async function runGet(client, name, { transform, ...options }) {
   );
 }
 
-export async function runUpdate(client, name, update, {
+export async function runIds(client, name, { update, transform, resolve, fields, ...options }) {
+  if (update) {
+    await stream.pipeline(
+      await buildUpdateStream(client, name, update, { ...options, fields: ['id', 'modified_gmt'] }),
+      new Transform({
+        objectMode: true,
+        transform({ id }, _, callback) {
+          callback(null, id);
+        },
+      }),
+      new stream.OutputStream(),
+    );
+  } else {
+    await stream.pipeline(
+      await client.entities(name).ids(options),
+      new stream.OutputStream(),
+    );
+  }
+}
+
+export async function runUpdate(client, name, update, options) {
+  await stream.pipeline(
+    await buildUpdateStream(client, name, update, options),
+    new stream.OutputStream(),
+  );
+}
+
+async function buildUpdateStream(client, name, update, {
   date, after, before, orderBy, order, // strip off date filters and order criteria
   transform,
   ...options
 }) {
+  // TODO: move the logic into client itself
   transform = await normalizeTransform(transform);
   const now = Date.now();
   update = parseDuration(update);
   const threshold = now - update;
   const entities = client.entities(name);
-  await stream.pipelineToStdout(
-    stream.concat(
-      ...await Promise.all([
-        // get recent published
-        entities.stream({
-          ...options,
-          transform,
-          after: threshold,
-        }),
-        // get recent modified, excluding ones already fetched
-        entities.stream({
-          ...options,
-          transform,
-          orderBy: 'modified',
-          before: threshold,
-          pageSize: 20,
-          strategy: {
-            highWatermark: 100,
-            eagerLoad: true,
-            terminate: entity => parseDate(entity.modified_gmt) < threshold,
-          },
-        })
-      ])
-    ),
-    stream.stringify(),
+  return stream.concat(
+    ...await Promise.all([
+      // get recent published
+      entities.stream({
+        ...options,
+        transform,
+        after: threshold,
+      }),
+      // get recent modified, excluding ones already fetched
+      entities.stream({
+        ...options,
+        transform,
+        orderBy: 'modified',
+        before: threshold,
+        pageSize: 20,
+        strategy: {
+          highWatermark: 100,
+          eagerLoad: true,
+          terminate: entity => parseDate(entity.modified_gmt) < threshold,
+        },
+      })
+    ])
   );
 }
 
 export default {
-  command: ['$0 <name>'],
+  command: ['$0 <name> [subcmd]'],
   desc: 'List entities from WordPress REST API',
   builder: build,
   handler: run,

package/cli/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { yargs } from '@miso.ai/server-commons';
 import version from '../src/version.js';
-import profile from './profile.js';
+import { profile, init } from './profile.js';
 import taxonomies from './taxonomies.js';
 import entities from './entities.js';
 
@@ -21,6 +21,7 @@ yargs.build(yargs => {
       default: false,
     })
     .hide('debug')
+    .command(init)
     .command(profile)
     .command(taxonomies)
     .command(entities)

package/cli/profile.js

@@ -11,7 +11,7 @@ function build(yargs) {
     });
 }
 
-async function run({ generate, ...options }) {
+async function runProfile({ generate, ...options }) {
   if (generate) {
     await runGenerate(options);
   } else {
@@ -38,9 +38,19 @@ async function runView(options) {
   console.log(JSON.stringify(client.profile, undefined, 2));
 }
 
-export default {
+async function runInit(options) {
+  await runGenerate(options);
+}
+
+export const profile = {
   command: 'profile',
   desc: 'WordPress site profile management',
   builder: build,
-  handler: run,
+  handler: runProfile,
+};
+
+export const init = {
+  command: 'init <site>',
+  desc: 'Initialize WordPress site profile',
+  handler: runInit,
 };

package/package.json

@@ -17,9 +17,9 @@
     "simonpai <simon.pai@askmiso.com>"
   ],
   "dependencies": {
-    "@miso.ai/server-commons": "0.6.3-beta.0",
+    "@miso.ai/server-commons": "0.6.3-beta.2",
     "axios": "^0.27.2",
     "axios-retry": "^3.3.1"
   },
-  "version": "0.6.3-beta.0"
+  "version": "0.6.3-beta.2"
 }

package/src/axios.js

@@ -1,6 +1,8 @@
 import axios from 'axios';
 import axiosRetry from 'axios-retry';
 
+// TODO: create an instance
+
 axiosRetry(axios, { retries: 5, retryDelay: count => count * 300 });
 
 export default axios;

package/src/entities/index.js

@@ -1,3 +1,4 @@
+import { Transform } from 'stream';
 import { asArray, stream } from '@miso.ai/server-commons';
 import EntityIndex from './entity-index.js';
 import EntityTransformStream from './transform.js';
@@ -14,6 +15,7 @@ export default class Entities {
   }
   
   async stream({ resolve = false, transform, ...options } = {}) {
+    // TODO: when after/before is used and fields are specified, we need to retain only fields that user wants
     if (!resolve && !transform) {
       return this._client._helpers.stream(this.name, options);
     }
@@ -53,6 +55,21 @@ export default class Entities {
       .pipe(transformStream);
   }
 
+  async ids(options = {}) {
+    const { before, after, u } = options;
+    const fields = ['id'];
+    if (before || after) {
+      fields.push('modified_gmt');
+    }
+    return (await this._client._helpers.stream(this.name, { ...options, fields }))
+      .pipe(new Transform({
+        objectMode: true,
+        transform({ id }, _, callback) {
+          callback(null, id);
+        },
+      }));
+  }
+
   async getAll(options) {
     return stream.collect(await this.stream(options));
   }

package/src/helpers.js

@@ -135,6 +135,7 @@ class Url {
   // https://make.wordpress.org/core/2021/02/23/rest-api-changes-in-wordpress-5-7/
   async append(url, options = {}) {
     const { after, before, order, orderBy, page, pageSize, offset, include, exclude } = options;
+    let { fields } = options;
     const params = [];
 
     // TODO: support single id
@@ -153,6 +154,12 @@ class Url {
     has(offset) && params.push(`offset=${offset}`);
     has(include) && include.length && params.push(`include=${joinIds(include)}`);
     has(exclude) && exclude.length && params.push(`exclude=${joinIds(exclude)}`);
+    if (has(fields) && fields.length) {
+      if (has(before) && !fields.includes('modified_gmt')) {
+        fields = [...fields, 'modified_gmt'];
+      }
+      params.push(`_fields=${fields.join(',')}`);
+    }
 
     const head = params.length === 0 ? '' : url.indexOf('?') < 0 ? '?' : '&';
     return `${url}${head}${params.join('&')}`;

package/src/version.js

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