feat(endpoint-micropub): channels

Author: paulrobertlloyd

packages/endpoint-micropub/lib/config.js

@@ -6,11 +6,12 @@
  */
 export const getConfig = (application, publication) => {
   const { mediaEndpoint, url } = application;
-  const { categories, postTypes, syndicationTargets } = publication;
+  const { categories, channels, postTypes, syndicationTargets } = publication;
 
   // Supported queries
   const q = [
     "category",
+    "channel",
     "config",
     "media-endpoint",
     "post-types",
@@ -28,6 +29,10 @@ export const getConfig = (application, publication) => {
 
   return {
     categories,
+    channels: Object.entries(channels).map(([uid, channel]) => ({
+      uid,
+      name: channel.name,
+    })),
     "media-endpoint": mediaEndpoint,
     "post-types": Object.values(postTypes).map((postType) => ({
       type: postType.type,

packages/endpoint-micropub/lib/controllers/query.js

@@ -25,6 +25,9 @@ export const queryController = async (request, response, next) => {
     // `category` param is used to query `categories` configuration property
     q = q === "category" ? "categories" : String(q);
 
+    // `channel` param is used to query `channels` configuration property
+    q = q === "channel" ? "channels" : String(q);
+
     switch (q) {
       case "config": {
         response.json(config);

packages/endpoint-micropub/lib/jf2.js

@@ -71,7 +71,7 @@ export const mf2ToJf2 = async (body, requestReferences) => {
  * @returns {object} Normalised JF2 properties
  */
 export const normaliseProperties = (publication, properties, timeZone) => {
-  const { me, slugSeparator } = publication;
+  const { channels, me, slugSeparator } = publication;
 
   properties.published = getDate(timeZone, properties.published);
 
@@ -101,6 +101,11 @@ export const normaliseProperties = (publication, properties, timeZone) => {
 
   properties.slug = getSlugProperty(properties, slugSeparator);
 
+  const publicationHasChannels = channels && Object.keys(channels).length > 0;
+  if (publicationHasChannels) {
+    properties["mp-channel"] = getChannelProperty(properties, channels);
+  }
+
   if (properties["mp-syndicate-to"]) {
     properties["mp-syndicate-to"] = toArray(properties["mp-syndicate-to"]);
   }
@@ -127,6 +132,44 @@ export const getAudioProperty = (properties, me) => {
   }));
 };
 
+/**
+ * Get channel property.
+ *
+ * If a publication has configured channels, but no channel has been selected,
+ * the default channel is used.
+ *
+ * If `mp-channel` provides a UID that does not appear in the publication’s
+ * channels, the default channel is used.
+ *
+ * The first item in a publication’s configured channels is considered the
+ * default channel.
+ * @param {object} properties - JF2 properties
+ * @param {object} channels - Publication channels
+ * @returns {Array} `mp-channel` property
+ * @see {@link https://github.com/indieweb/micropub-extensions/issues/40}
+ */
+export const getChannelProperty = (properties, channels) => {
+  channels = Object.keys(channels);
+  const mpChannel = properties["mp-channel"];
+  const providedChannels = Array.isArray(mpChannel) ? mpChannel : [mpChannel];
+  const selectedChannels = new Set();
+
+  // Only select channels that have been configured
+  for (const uid of providedChannels) {
+    if (channels.includes(uid)) {
+      selectedChannels.add(uid);
+    }
+  }
+
+  // If no channels provided, use default channel UID
+  if (selectedChannels.size === 0) {
+    const defaultChannel = channels[0];
+    selectedChannels.add(defaultChannel);
+  }
+
+  return toArray([...selectedChannels]);
+};
+
 /**
  * Get content property.
  *

packages/endpoint-micropub/lib/post-data.js

@@ -48,8 +48,14 @@ export const postData = {
       typeConfig.post.path,
       properties,
       application,
+      publication,
+    );
+    const url = await renderPath(
+      typeConfig.post.url,
+      properties,
+      application,
+      publication,
     );
-    const url = await renderPath(typeConfig.post.url, properties, application);
     properties.url = getCanonicalUrl(url, me);
 
     // Post status
@@ -144,11 +150,13 @@ export const postData = {
       typeConfig.post.path,
       properties,
       application,
+      publication,
     );
     const updatedUrl = await renderPath(
       typeConfig.post.url,
       properties,
       application,
+      publication,
     );
     properties.url = getCanonicalUrl(updatedUrl, me);
 
@@ -208,6 +216,7 @@ export const postData = {
       typeConfig.post.path,
       properties,
       application,
+      publication,
     );
 
     // Update data in posts collection
@@ -249,6 +258,7 @@ export const postData = {
       typeConfig.post.path,
       properties,
       application,
+      publication,
     );
 
     // Post status

packages/endpoint-micropub/lib/utils.js

@@ -50,6 +50,11 @@ export const getPostTemplateProperties = (properties) => {
   const templateProperties = structuredClone(properties);
 
   for (let key in templateProperties) {
+    // Pass mp-channel to template as channel
+    if (key === "mp-channel") {
+      templateProperties.channel = templateProperties["mp-channel"];
+    }
+
     // Remove server commands from post template properties
     if (key.startsWith("mp-")) {
       delete templateProperties[key];
@@ -78,12 +83,19 @@ export const relativeMediaPath = (url, me) =>
  * @param {string} path - URI template path
  * @param {object} properties - JF2 properties
  * @param {object} application - Application configuration
+ * @param {object} publication - Publication configuration
  * @returns {Promise<string>} Path
  */
-export const renderPath = async (path, properties, application) => {
+export const renderPath = async (
+  path,
+  properties,
+  application,
+  publication,
+) => {
   const dateObject = new Date(properties.published);
   const serverTimeZone = getTimeZoneDesignator();
   const { locale, timeZone } = application;
+  const { slugSeparator } = publication;
   let tokens = {};
 
   // Add date tokens
@@ -105,6 +117,13 @@ export const renderPath = async (path, properties, application) => {
   // Add slug token
   tokens.slug = properties.slug;
 
+  // Add channel token
+  if (properties.channel) {
+    tokens.channel = Array.isArray(properties.channel)
+      ? properties.channel.join(slugSeparator)
+      : properties.channel;
+  }
+
   // Populate URI template path with properties
   path = supplant(path, tokens);
 

packages/endpoint-micropub/test/unit/jf2.js

@@ -6,6 +6,7 @@ import {
   formEncodedToJf2,
   mf2ToJf2,
   getAudioProperty,
+  getChannelProperty,
   getContentProperty,
   getLocationProperty,
   getPhotoProperty,
@@ -17,6 +18,14 @@ import {
 
 await mockAgent("endpoint-micropub");
 const publication = {
+  channels: {
+    posts: {
+      name: "Posts",
+    },
+    pages: {
+      name: "Pages",
+    },
+  },
   slugSeparator: "-",
   syndicationTargets: [
     {
@@ -132,6 +141,28 @@ describe("endpoint-micropub/lib/jf2", () => {
     ]);
   });
 
+  it("Gets normalised channel property", () => {
+    const one = { "mp-channel": "posts" };
+    const none = { "mp-channel": "" };
+    const many = { "mp-channel": ["posts", "pages"] };
+    const { channels } = publication;
+
+    assert.deepEqual(getChannelProperty(one, channels), ["posts"]);
+    assert.deepEqual(getChannelProperty(none, channels), ["posts"]);
+    assert.deepEqual(getChannelProperty(many, channels), ["posts", "pages"]);
+  });
+
+  it("Gets normalised channel property, returning default channel", () => {
+    const oneMissing = { "mp-channel": "foo" };
+    const manyMissing = { "mp-channel": ["foo", "bar"] };
+    const someMissing = { "mp-channel": ["foo", "bar", "pages"] };
+    const { channels } = publication;
+
+    assert.deepEqual(getChannelProperty(oneMissing, channels), ["posts"]);
+    assert.deepEqual(getChannelProperty(manyMissing, channels), ["posts"]);
+    assert.deepEqual(getChannelProperty(someMissing, channels), ["pages"]);
+  });
+
   it("Gets text and HTML values from `content` property", () => {
     const properties = JSON.parse(
       getFixture("jf2/article-content-provided-html-text.jf2"),
@@ -400,6 +431,7 @@ describe("endpoint-micropub/lib/jf2", () => {
     );
     const result = normaliseProperties(publication, properties, "UTC");
 
+    assert.equal(result.channels, undefined);
     assert.equal(result.type, "entry");
     assert.equal(result.name, "What I had for lunch");
     assert.equal(result.slug, "what-i-had-for-lunch");

packages/endpoint-micropub/test/unit/utils.js

@@ -62,9 +62,10 @@ describe("endpoint-media/lib/utils", () => {
   });
 
   it("Renders path from URI template and properties", async () => {
-    const template = "{yyyy}/{MM}/{slug}";
+    const template = "{channel}/{yyyy}/{MM}/{slug}";
     const properties = {
       published: "2020-01-01",
+      channel: ["foo", "bar"],
       slug: "foo",
     };
     const application = {
@@ -83,9 +84,17 @@ describe("endpoint-media/lib/utils", () => {
         },
       },
     };
-    const result = await renderPath(template, properties, application);
+    const publication = {
+      slugSeparator: "_",
+    };
+    const result = await renderPath(
+      template,
+      properties,
+      application,
+      publication,
+    );
 
-    assert.match(result, /\d{4}\/\d{2}\/foo/);
+    assert.match(result, /foo_bar\/\d{4}\/\d{2}\/foo/);
   });
 
   it("Convert string to array if not already an array", () => {