@rmdes/indiekit-endpoint-posts 1.0.0-beta.25

package/README.md

@@ -0,0 +1,43 @@
+# @rmdes/indiekit-endpoint-posts
+
+Post management endpoint for Indiekit. View posts published by your Micropub endpoint and publish new posts to it.
+
+## Fork Notice
+
+This is a fork of `@indiekit/endpoint-posts` with a critical bug fix for the syndication form.
+
+### Bug Fixed
+
+The syndicate form button was using `data.url` for the `source_url` value, but `data` is never defined in the template context (the controller sets `properties`, not `data`). This caused the wrong post to be syndicated when clicking the "Syndicate" button.
+
+**PR submitted upstream:** https://github.com/getindiekit/indiekit/pull/828
+
+## Installation
+
+```bash
+npm install @rmdes/indiekit-endpoint-posts
+```
+
+### Using npm overrides (recommended)
+
+Add to your `package.json`:
+
+```json
+{
+  "overrides": {
+    "@indiekit/endpoint-posts": "npm:@rmdes/indiekit-endpoint-posts@^1.0.0-beta.25"
+  }
+}
+```
+
+This replaces the upstream package with this fork without changing your plugin configuration.
+
+## Options
+
+| Option      | Type     | Description                                                     |
+| :---------- | :------- | :-------------------------------------------------------------- |
+| `mountPath` | `string` | Path to management interface. _Optional_, defaults to `/posts`. |
+
+## License
+
+MIT - Original work by Paul Robert Lloyd, bug fix by Ricardo Mendes.

package/assets/icon.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 96 96">
+  <path fill="#60C" d="M0 0h96v96H0z"/>
+  <path fill="#FFF" d="M76 13a4 4 0 0 1 4 4v62a4 4 0 0 1-4 4H20a4 4 0 0 1-4-4V17a4 4 0 0 1 4-4h56Zm-4 56H24v6h48v-6Zm0-12H24v6h48v-6Zm0-36H50v30h22V21ZM44 45H24v6h20v-6Zm0-12H24v6h20v-6Zm0-12H24v6h20v-6Z"/>
+</svg>

package/includes/@indiekit-endpoint-posts-syndicate.njk

@@ -0,0 +1,21 @@
+<form action="{{ application._syndicationEndpointPath }}" method="post">
+  {{ input({
+    name: "access_token",
+    type: "hidden",
+    value: token
+  }) | indent(2) }}
+
+  {{ input({
+    name: "syndication[redirect_uri]",
+    type: "hidden",
+    value: redirectUri
+  }) | indent(2) }}
+
+  {{ button({
+    classes: "button--secondary button--small",
+    name: "syndication[source_url]",
+    value: properties.url,
+    icon: "syndicate",
+    text: __("posts.post.syndicate")
+  }) | indent(2) }}
+</form>

package/includes/@indiekit-endpoint-posts-widget.njk

@@ -0,0 +1,14 @@
+{% if application.micropubEndpoint %}
+{% call widget({
+  title: __("posts.create.title", ""),
+  image: "/assets/" + plugin.id + "/icon.svg"
+}) %}
+  <div class="button-grid">{% for type, config in publication.postTypes | dictsort %}
+    {{ button({
+      classes: "button--secondary-on-offset button--inline",
+      href: application.postsEndpoint + "/create/?type=" + config.type,
+      text: (icon(config.type) or icon("note")) + config.name
+    }) }}
+  {% endfor %}</div>
+{% endcall %}
+{% endif %}

package/includes/post-types/category-field.njk

@@ -0,0 +1,11 @@
+{{ tagInput({
+  name: "category",
+  value: fieldData("category").value,
+  label: __("posts.form.category.label"),
+  hint: __("posts.form.category.hint"),
+  optional: not field.required,
+  localisation: {
+    tag: __("posts.form.category.tag"),
+    tags: __("posts.form.category.label") | lower
+  }
+}) }}

package/includes/post-types/category.njk

@@ -0,0 +1,4 @@
+{{ tag({
+  label: __("posts.form.category.label"),
+  items: property
+}) if property }}

package/includes/post-types/content-field.njk

@@ -0,0 +1,17 @@
+{{ textarea({
+  name: "content",
+  value: properties.content.text or fieldData("content").value,
+  label: __("posts.form.content.label"),
+  optional: not field.required,
+  errorMessage: fieldData("content").errorMessage,
+  field: {
+    attributes: {
+      editor: true,
+      "editor-endpoint": application.mediaEndpoint,
+      "editor-id": (properties.uid or ("new-" + postType)) + "-content",
+      "editor-locale": application.locale,
+      "editor-image-upload": "false" if postType == "note" or postType == "photo",
+      "editor-status": "false" if not field.required
+    }
+  }
+}) }}

package/includes/post-types/content.njk

@@ -0,0 +1,3 @@
+{{ prose({
+  html: property.text | markdown
+}) if property }}

package/includes/post-types/featured-field.njk

@@ -0,0 +1,30 @@
+{% call fieldset({
+  classes: "fieldset--group",
+  legend: __("posts.form.featured.label"),
+  optional: not field.required
+}) %}
+  {{ fileInput({
+    field: {
+      attributes: {
+        endpoint: application.mediaEndpoint
+      }
+    },
+    name: "featured[url]",
+    type: "url",
+    value: fieldData("featured.url").value,
+    label: __("posts.form.media.label"),
+    accept: "image/*",
+    attributes: {
+      placeholder: "https://"
+    },
+    errorMessage: fieldData("featured.url").errorMessage
+  }) | indent(2) }}
+
+  {{ textarea({
+    name: "featured[alt]",
+    value: fieldData("featured.alt").value,
+    label: __("posts.form.featured.alt"),
+    rows: 1,
+    errorMessage: fieldData("featured.alt").errorMessage
+  }) | indent(2) }}
+{% endcall %}

package/includes/post-types/featured.njk

@@ -0,0 +1,8 @@
+{% set html %}
+<figure>
+  <img src="{{ property[0].url | url(publication.me) }}" alt="{{ property[0].alt }}">
+</figure>
+{% endset -%}
+{{- prose({
+  html: html
+}) if property }}

package/includes/post-types/geo-field.njk

@@ -0,0 +1,8 @@
+{{ geoInput({
+  name: "geo",
+  value: geo,
+  label: __("posts.form.geo.label"),
+  hint: __("posts.form.geo.hint", "50.8211, -0.1452"),
+  optional: not field.required,
+  errorMessage: fieldData("geo").errorMessage
+}) }}

package/includes/post-types/location-field.njk

@@ -0,0 +1,42 @@
+{% call fieldset({
+  classes: "fieldset--group",
+  legend: __("posts.form.location.label"),
+  optional: not field.required
+}) %}
+  {{ input({
+    name: "location[name]",
+    value: fieldData("location.name").value,
+    label: __("posts.form.location.name")
+  }) | indent(2) }}
+
+  {{ input({
+    name: "location[street-address]",
+    value: fieldData("location.street-address").value,
+    label: __("posts.form.location.street-address"),
+    autocomplete: "address-line1"
+  }) | indent(2) }}
+
+  {{ input({
+    classes: "input--width-25",
+    name: "location[locality]",
+    value: fieldData("location.locality").value,
+    label: __("posts.form.location.locality"),
+    autocomplete: "address-level2"
+  }) | indent(2) }}
+
+  {{ input({
+    classes: "input--width-25",
+    name: "location[country-name]",
+    value: fieldData("location.country-name").value,
+    label: __("posts.form.location.country-name"),
+    autocomplete: "country-name"
+  }) | indent(2) }}
+
+  {{ input({
+    classes: "input--width-10",
+    name: "location[postal-code]",
+    value: fieldData("location.postal-code").value,
+    label: __("posts.form.location.postal-code"),
+    autocomplete: "postal-code"
+  }) | indent(2) }}
+{% endcall %}

package/includes/post-types/location.njk

@@ -0,0 +1,12 @@
+{% set html -%}
+  {{- icon("location") -}}
+  {{- property.name + ", " if property.name -}}
+  {{- property["street-address"] + ", " if property["street-address"] -}}
+  {{- property.locality + ", " if property.locality -}}
+  {{- property["country-name"] + ". " if property["country-name"] -}}
+  {{- property["postal-code"] if property["postal-code"] -}}
+{%- endset -%}
+{{- prose({
+  classes: "prose--caption",
+  html: html
+}) if property }}

package/includes/post-types/mp-channel.njk

@@ -0,0 +1,4 @@
+{{ tag({
+  label: __("posts.form.mp-channel.label"),
+  items: publication.channels[property].name
+}) if property }}

package/includes/post-types/name-field.njk

@@ -0,0 +1,7 @@
+{{ input({
+  name: "name",
+  value: fieldData("name").value,
+  label: __("posts.form.name.label"),
+  optional: not field.required,
+  errorMessage: fieldData("name").errorMessage
+}) }}

package/includes/post-types/published.njk

@@ -0,0 +1,4 @@
+<dl class="prose--caption">
+  <dt class="-!-visually-hidden">{{ __("posts.form.published.label") }}</dt>
+  <dd><time datetime="{{ property }}">{{ property | date("PPPppp", { locale: opts.locale, timeZone: application.timeZone }) }}</time></dd>
+</dl>

package/includes/post-types/summary-field.njk

@@ -0,0 +1,17 @@
+{{ textarea({
+  name: "summary",
+  value: properties.summary,
+  label: __("posts.form.summary.label"),
+  optional: not field.required,
+  rows: 1,
+  field: {
+    attributes: {
+      editor: true,
+      "editor-endpoint": application.mediaEndpoint,
+      "editor-id": (properties.uid or ("new-" + postType)) + "-summary",
+      "editor-locale": application.locale,
+      "editor-status": "false",
+      "editor-toolbar": "false"
+    }
+  }
+}) }}

package/includes/post-types/summary.njk

@@ -0,0 +1,4 @@
+{{ prose({
+  classes: "prose--subhead",
+  html: property
+}) if property }}

package/index.js

@@ -0,0 +1,108 @@
+import path from "node:path";
+
+import { tagInputSanitizer } from "@indiekit/frontend";
+import { ISO_6709_RE, isRequired } from "@indiekit/util";
+import express from "express";
+
+import { deleteController } from "./lib/controllers/delete.js";
+import { formController } from "./lib/controllers/form.js";
+import { newController } from "./lib/controllers/new.js";
+import { postController } from "./lib/controllers/post.js";
+import { postsController } from "./lib/controllers/posts.js";
+import { postData } from "./lib/middleware/post-data.js";
+import { validate } from "./lib/middleware/validation.js";
+
+const defaults = { mountPath: "/posts" };
+const router = express.Router();
+
+export default class PostsEndpoint {
+  name = "Post management endpoint";
+
+  constructor(options = {}) {
+    this.options = { ...defaults, ...options };
+    this.mountPath = this.options.mountPath;
+  }
+
+  get navigationItems() {
+    return {
+      href: this.options.mountPath,
+      text: "posts.title",
+      requiresDatabase: true,
+    };
+  }
+
+  get shortcutItems() {
+    return {
+      url: path.join(this.options.mountPath, "new"),
+      name: "posts.create.action",
+      iconName: "createPost",
+      requiresDatabase: true,
+    };
+  }
+
+  get routes() {
+    router.get("/", postsController);
+
+    router.get("/new", newController.get);
+    router.post("/new", validate.new, newController.post);
+
+    router.get("/create", postData.create, formController.get);
+    router.post("/create", postData.create, validate.form, formController.post);
+
+    router.use("/:uid{/:action}", postData.read);
+    router.get("/:uid", postController);
+
+    router.get("/:uid/update", formController.get);
+    router.post("/:uid/update", validate.form, formController.post);
+
+    router.get(["/:uid/delete", "/:uid/undelete"], deleteController.get);
+    router.post(["/:uid/delete", "/:uid/undelete"], deleteController.post);
+
+    return router;
+  }
+
+  get validationSchemas() {
+    return {
+      category: {
+        exists: { if: (value, { req }) => req.body?.category },
+        tagInput: tagInputSanitizer,
+        isArray: true,
+      },
+      content: {
+        errorMessage: (value, { req }) => req.__("posts.error.content.empty"),
+        exists: { if: (value, { req }) => isRequired(req, "content") },
+        notEmpty: true,
+      },
+      "featured.url": {
+        errorMessage: (value, { req }) =>
+          req.__(`posts.error.media.empty`, "/photos/image.jpg"),
+        exists: { if: (value, { req }) => isRequired(req, "featured") },
+        notEmpty: true,
+      },
+      "featured.alt": {
+        errorMessage: (value, { req }) =>
+          req.__(`posts.error.featured-alt.empty`),
+        exists: { if: (value, { req }) => req.body?.featured.url },
+        notEmpty: true,
+      },
+      geo: {
+        errorMessage: (value, { req }) => req.__(`posts.error.geo.invalid`),
+        exists: { if: (value, { req }) => req.body?.geo },
+        custom: {
+          options: (value) => value.match(ISO_6709_RE),
+        },
+      },
+      name: {
+        errorMessage: (value, { req }) => req.__("posts.error.name.empty"),
+        exists: { if: (value, { req }) => isRequired(req, "name") },
+        notEmpty: true,
+      },
+    };
+  }
+
+  init(Indiekit) {
+    Indiekit.addEndpoint(this);
+    Indiekit.addPostType(false, this);
+    Indiekit.config.application.postsEndpoint = this.mountPath;
+  }
+}

package/lib/controllers/delete.js

@@ -0,0 +1,52 @@
+import { checkScope } from "@indiekit/endpoint-micropub/lib/scope.js";
+
+import { endpoint } from "../endpoint.js";
+
+export const deleteController = {
+  /**
+   * Confirm post to delete/undelete
+   * @type {import("express").RequestHandler}
+   */
+  async get(request, response) {
+    const { action, postName, postsPath, scope } = response.locals;
+
+    if (scope && checkScope(scope, action)) {
+      return response.render("post-delete", {
+        title: response.locals.__(`posts.${action}.title`),
+        parent: { text: postName },
+      });
+    }
+
+    response.redirect(postsPath);
+  },
+
+  /**
+   * Post delete/undelete action to Micropub endpoint
+   * @type {import("express").RequestHandler}
+   */
+  async post(request, response) {
+    const { micropubEndpoint } = request.app.locals.application;
+    const { accessToken, action, postName, properties } = response.locals;
+
+    try {
+      const micropubUrl = new URL(micropubEndpoint);
+      micropubUrl.searchParams.append("action", action);
+      micropubUrl.searchParams.append("url", properties.url);
+
+      const micropubResponse = await endpoint.post(
+        micropubUrl.href,
+        accessToken,
+      );
+      const message = encodeURIComponent(micropubResponse.success_description);
+
+      response.redirect(`${request.baseUrl}?success=${message}`);
+    } catch (error) {
+      response.status(error.status || 500);
+      response.render("post-delete", {
+        title: response.locals.__(`posts.${action}.title`),
+        parent: { text: postName },
+        error,
+      });
+    }
+  },
+};

package/lib/controllers/form.js

@@ -0,0 +1,121 @@
+import path from "node:path";
+
+import { jf2ToMf2 } from "@indiekit/endpoint-micropub/lib/mf2.js";
+import { checkScope } from "@indiekit/endpoint-micropub/lib/scope.js";
+import { formatLocalToZonedDate, sanitise } from "@indiekit/util";
+import { validationResult } from "express-validator";
+
+import { endpoint } from "../endpoint.js";
+import { getLocationProperty } from "../utils.js";
+
+export const formController = {
+  /**
+   * Get post to create/update
+   * @type {import("express").RequestHandler}
+   */
+  async get(request, response) {
+    const { action, postsPath, postType, name, scope } = response.locals;
+
+    if (scope && checkScope(scope, action)) {
+      return response.render("post-form", {
+        back:
+          action === "create"
+            ? {
+                href: `${path.join(postsPath, "new")}?type=${postType}`,
+                text: response.locals.__(`posts.form.back`),
+              }
+            : {
+                href: path.dirname(request.baseUrl + request.path),
+              },
+        title: response.locals.__(
+          `posts.${action}.title`,
+          name.toLowerCase().replace("rsvp", "RSVP"),
+        ),
+      });
+    }
+
+    response.redirect(postsPath);
+  },
+
+  /**
+   * Post to Micropub endpoint
+   * @type {import("express").RequestHandler}
+   */
+  async post(request, response) {
+    const { micropubEndpoint, timeZone } = request.app.locals.application;
+    const { accessToken, action, name, properties } = response.locals;
+
+    const errors = validationResult(request);
+    if (!errors.isEmpty()) {
+      return response.status(422).render("post-form", {
+        title: response.locals.__(
+          `posts.${action}.title`,
+          name.toLowerCase().replace("rsvp", "RSVP"),
+        ),
+        errors: errors.mapped(),
+      });
+    }
+
+    try {
+      const values = request.body;
+      if (values["publication-date"] === "now") {
+        // Remove empty local date value and let server set date
+        delete values.published;
+      } else {
+        // Add timezone designator to local date value
+        values.published = formatLocalToZonedDate(values.published, timeZone);
+      }
+
+      // Convert media values object to Array
+      for (const key of ["audio", "photo", "video"]) {
+        if (values[key]) {
+          values[key] = Object.values(values[key]);
+        }
+      }
+
+      // Derive location from location and/or geo values
+      if (values.location || values.geo) {
+        values.location = getLocationProperty(values);
+      }
+
+      // Delete non-MF2 properties
+      // @todo Use `properties` for field names whose values should be submitted
+      delete values["all-day"];
+      delete values.geo;
+      delete values.postType;
+      delete values["publication-date"];
+
+      // Easy MDE appends `image` value to formData for last image uploaded
+      delete values.image;
+
+      const mf2 = jf2ToMf2({ properties: sanitise(values) });
+
+      let jsonBody = mf2;
+      if (action === "update") {
+        jsonBody = {
+          action,
+          url: properties.url,
+          replace: mf2.properties,
+        };
+      }
+
+      const micropubResponse = await endpoint.post(
+        micropubEndpoint,
+        accessToken,
+        jsonBody,
+      );
+      const message = encodeURIComponent(micropubResponse.success_description);
+
+      response.redirect(`${request.baseUrl}?success=${message}`);
+    } catch (error) {
+      response.status(error.status || 500);
+      response.render("post-form", {
+        title: response.locals.__(
+          `posts.${action}.title`,
+          name.toLowerCase().replace("rsvp", "RSVP"),
+        ),
+        error,
+      });
+    }
+  },
+};

package/lib/controllers/new.js

@@ -0,0 +1,87 @@
+import path from "node:path";
+
+import { checkScope } from "@indiekit/endpoint-micropub/lib/scope.js";
+import { validationResult } from "express-validator";
+
+export const newController = {
+  /**
+   * Get new post type to create
+   * @type {import("express").RequestHandler}
+   */
+  async get(request, response) {
+    const action = "create";
+    const { publication } = request.app.locals;
+    const postsPath = path.dirname(request.baseUrl + request.path);
+    const postType = request.query.type;
+    const { scope } = request.session;
+
+    const postTypeItems = Object.values(publication.postTypes)
+      .toSorted((a, b) => {
+        return a.name.localeCompare(b.name);
+      })
+      .map((postType) => ({
+        label: postType.name,
+        value: postType.type,
+      }));
+
+    response.locals = {
+      action,
+      postsPath,
+      postType,
+      postTypeItems,
+      scope,
+      ...response.locals,
+    };
+
+    if (scope && checkScope(scope, action)) {
+      return response.render("new", {
+        back: {
+          href: postsPath,
+        },
+        title: response.locals.__(`posts.new.title`),
+      });
+    }
+
+    response.redirect(postsPath);
+  },
+
+  /**
+   * Redirect to post creation form for selected post type
+   * @type {import("express").RequestHandler}
+   */
+  async post(request, response) {
+    const { publication } = request.app.locals;
+    const postsPath = path.dirname(request.baseUrl + request.path);
+
+    const postTypeItems = Object.values(publication.postTypes)
+      .toSorted((a, b) => {
+        return a.name.localeCompare(b.name);
+      })
+      .map((postType) => ({
+        label: postType.name,
+        value: postType.type,
+      }));
+
+    const errors = validationResult(request);
+    if (!errors.isEmpty()) {
+      return response.status(422).render("new", {
+        title: response.locals.__(`posts.new.title`),
+        postsPath,
+        postTypeItems,
+        errors: errors.mapped(),
+      });
+    }
+
+    try {
+      const { type } = request.body;
+
+      response.redirect(`${request.baseUrl}/create?type=${type}`);
+    } catch (error) {
+      response.status(error.status || 500);
+      response.render("new", {
+        title: response.locals.__(`posts.new.title`),
+        error,
+      });
+    }
+  },
+};