@evfrenkel/decap-cms-core 3.13.0-image-conversions.0

package/src/lib/formatters.ts

@@ -0,0 +1,297 @@
+import flow from 'lodash/flow';
+import partialRight from 'lodash/partialRight';
+import trimEnd from 'lodash/trimEnd';
+import trimStart from 'lodash/trimStart';
+import { stringTemplate } from 'decap-cms-lib-widgets';
+import { stripIndent } from 'common-tags';
+
+import {
+  selectIdentifier,
+  selectField,
+  selectInferredField,
+  getFileFromSlug,
+} from '../reducers/collections';
+import { sanitizeSlug } from './urlHelper';
+import { FILES } from '../constants/collectionTypes';
+import { COMMIT_AUTHOR, COMMIT_DATE } from '../constants/commitProps';
+
+import type { Collection, CmsConfig, CmsSlug, EntryMap } from '../types/redux';
+import type { Map } from 'immutable';
+
+const {
+  compileStringTemplate,
+  parseDateFromEntry,
+  parseDateFromEntryData,
+  SLUG_MISSING_REQUIRED_DATE,
+  keyToPathArray,
+  addFileTemplateFields,
+} = stringTemplate;
+
+const commitMessageTemplates = {
+  create: 'Create {{collection}} “{{slug}}”',
+  update: 'Update {{collection}} “{{slug}}”',
+  delete: 'Delete {{collection}} “{{slug}}”',
+  uploadMedia: 'Upload “{{path}}”',
+  deleteMedia: 'Delete “{{path}}”',
+  openAuthoring: '{{message}}',
+} as const;
+
+const variableRegex = /\{\{([^}]+)\}\}/g;
+
+type Options = {
+  slug?: string;
+  path?: string;
+  collection?: Collection;
+  authorLogin?: string;
+  authorName?: string;
+  authorEmail?: string;
+};
+
+export function commitMessageFormatter(
+  type: keyof typeof commitMessageTemplates,
+  config: CmsConfig,
+  { slug, path, collection, authorLogin, authorName, authorEmail }: Options,
+  isOpenAuthoring?: boolean,
+) {
+  const templates = { ...commitMessageTemplates, ...(config.backend.commit_messages || {}) };
+
+  let trailers = '';
+  if (config.backend.signoff_commits) {
+    if (!authorName) {
+      console.warn('Option signoff_commits is enabled, but author name is unknown');
+    } else if (!authorEmail) {
+      console.warn('Option signoff_commits is enabled, but author email is unknown');
+    } else {
+      trailers = `\n\nSigned-off-by: ${authorName} <${authorEmail}>\n`;
+    }
+  }
+
+  const commitMessage = templates[type].replace(variableRegex, (_, variable) => {
+    switch (variable) {
+      case 'slug':
+        return slug || '';
+      case 'path':
+        return path || '';
+      case 'collection':
+        return collection ? collection.get('label_singular') || collection.get('label') : '';
+      case 'author-login':
+        return authorLogin || '';
+      case 'author-name':
+        return authorName || '';
+      default:
+        console.warn(`Ignoring unknown variable “${variable}” in commit message template.`);
+        return '';
+    }
+  });
+
+  if (!isOpenAuthoring) {
+    return commitMessage + trailers;
+  }
+
+  const message = templates.openAuthoring.replace(variableRegex, (_, variable) => {
+    switch (variable) {
+      case 'message':
+        return commitMessage;
+      case 'author-login':
+        return authorLogin || '';
+      case 'author-name':
+        return authorName || '';
+      default:
+        console.warn(`Ignoring unknown variable “${variable}” in open authoring message template.`);
+        return '';
+    }
+  });
+
+  return message + trailers;
+}
+
+export function prepareSlug(slug: string) {
+  return (
+    slug
+      .trim()
+      // Convert slug to lower-case
+      .toLocaleLowerCase()
+
+      // Remove single quotes.
+      .replace(/[']/g, '')
+
+      // Replace periods with dashes.
+      .replace(/[.]/g, '-')
+  );
+}
+
+export function getProcessSegment(
+  slugConfig?: CmsSlug,
+  ignoreValues?: string[],
+  preserveSlashes?: boolean,
+) {
+  return (value: string) =>
+    ignoreValues && ignoreValues.includes(value)
+      ? value
+      : flow([
+          value => String(value),
+          prepareSlug,
+          partialRight(sanitizeSlug, slugConfig, preserveSlashes),
+        ])(value);
+}
+
+export function slugFormatter(
+  collection: Collection,
+  entryData: Map<string, unknown>,
+  slugConfig?: CmsSlug,
+) {
+  const slugTemplate = collection.get('slug') || '{{slug}}';
+
+  const identifier = entryData.getIn(keyToPathArray(selectIdentifier(collection) as string));
+  if (!identifier) {
+    throw new Error(
+      'Collection must have a field name that is a valid entry identifier, or must have `identifier_field` set',
+    );
+  }
+
+  const processSegment = getProcessSegment(slugConfig);
+  const date =
+    parseDateFromEntryData(
+      entryData as unknown as Map<string, unknown>,
+      selectInferredField(collection, 'date'),
+    ) || new Date(Date.now());
+  const slug = compileStringTemplate(slugTemplate, date, identifier, entryData, processSegment);
+
+  if (!collection.has('path')) {
+    return slug;
+  } else {
+    const pathTemplate = prepareSlug(collection.get('path') as string);
+    return compileStringTemplate(pathTemplate, date, slug, entryData, (value: string) =>
+      value === slug ? value : processSegment(value),
+    );
+  }
+}
+
+export function previewUrlFormatter(
+  baseUrl: string,
+  collection: Collection,
+  slug: string,
+  entry: EntryMap,
+  slugConfig?: CmsSlug,
+) {
+  /**
+   * Preview URL can't be created without `baseUrl`. This makes preview URLs
+   * optional for backends that don't support them.
+   */
+  if (!baseUrl) {
+    return;
+  }
+
+  const basePath = trimEnd(baseUrl, '/');
+
+  const isFileCollection = collection.get('type') === FILES;
+  const file = isFileCollection ? getFileFromSlug(collection, entry.get('slug')) : undefined;
+
+  function getPathTemplate() {
+    return file?.get('preview_path') ?? collection.get('preview_path');
+  }
+
+  function getDateField() {
+    return file?.get('preview_path_date_field') ?? collection.get('preview_path_date_field');
+  }
+
+  /**
+   * If a `previewPath` is provided for the collection/file, use it to construct the
+   * URL path.
+   */
+  const pathTemplate = getPathTemplate();
+
+  /**
+   * Without a `previewPath` for the collection/file (via config), the preview URL
+   * will be the URL provided by the backend.
+   */
+  if (!pathTemplate) {
+    return baseUrl;
+  }
+
+  let fields = entry.get('data') as Map<string, string>;
+  fields = addFileTemplateFields(entry.get('path'), fields, collection.get('folder'));
+  const dateFieldName = getDateField() || selectInferredField(collection, 'date');
+  const date = parseDateFromEntry(entry as unknown as Map<string, unknown>, dateFieldName);
+  const previewPathPreserveSlashes = collection.get('preview_path_preserve_slashes');
+  const preserveSlashes = !!(previewPathPreserveSlashes ?? collection.has('nested'));
+
+  // Prepare and sanitize slug variables only, leave the rest of the
+  // `preview_path` template as is.
+  const processSegment = getProcessSegment(slugConfig, [fields.get('dirname')], preserveSlashes);
+  let compiledPath;
+
+  try {
+    compiledPath = compileStringTemplate(pathTemplate, date, slug, fields, processSegment);
+  } catch (err: unknown) {
+    // Print an error and ignore `preview_path` if both:
+    //   1. Date is invalid (according to DayJs), and
+    //   2. A date expression (eg. `{{year}}`) is used in `preview_path`
+    if (err instanceof Error && err.name === SLUG_MISSING_REQUIRED_DATE) {
+      console.error(stripIndent`
+        Collection "${collection.get('name')}" configuration error:
+          \`preview_path_date_field\` must be a field with a valid date. Ignoring \`preview_path\`.
+      `);
+      return basePath;
+    }
+    throw err;
+  }
+
+  const previewPath = trimStart(compiledPath, ' /');
+  return `${basePath}/${previewPath}`;
+}
+
+export function summaryFormatter(summaryTemplate: string, entry: EntryMap, collection: Collection) {
+  let entryData = entry.get('data');
+  const date =
+    parseDateFromEntry(
+      entry as unknown as Map<string, unknown>,
+      selectInferredField(collection, 'date'),
+    ) || null;
+  const identifier = entryData.getIn(keyToPathArray(selectIdentifier(collection) as string));
+
+  entryData = addFileTemplateFields(entry.get('path'), entryData, collection.get('folder'));
+  // allow commit information in summary template
+  if (entry.get('author') && !selectField(collection, COMMIT_AUTHOR)) {
+    entryData = entryData.set(COMMIT_AUTHOR, entry.get('author'));
+  }
+  if (entry.get('updatedOn') && !selectField(collection, COMMIT_DATE)) {
+    entryData = entryData.set(COMMIT_DATE, entry.get('updatedOn'));
+  }
+  const summary = compileStringTemplate(summaryTemplate, date, identifier, entryData);
+  return summary;
+}
+
+export function folderFormatter(
+  folderTemplate: string,
+  entry: EntryMap | undefined,
+  collection: Collection,
+  defaultFolder: string,
+  folderKey: string,
+  slugConfig?: CmsSlug,
+) {
+  if (!entry || !entry.get('data')) {
+    return folderTemplate;
+  }
+
+  let fields = (entry.get('data') as Map<string, string>).set(folderKey, defaultFolder);
+  fields = addFileTemplateFields(entry.get('path'), fields, collection.get('folder'));
+
+  const date =
+    parseDateFromEntry(
+      entry as unknown as Map<string, unknown>,
+      selectInferredField(collection, 'date'),
+    ) || null;
+  const identifier = fields.getIn(keyToPathArray(selectIdentifier(collection) as string));
+  const processSegment = getProcessSegment(slugConfig, [defaultFolder, fields.get('dirname')]);
+
+  const mediaFolder = compileStringTemplate(
+    folderTemplate,
+    date,
+    identifier,
+    fields,
+    processSegment,
+  );
+
+  return mediaFolder;
+}