strapi-relation-names 1.2.2 → 1.3.1

package/README.md

@@ -11,7 +11,7 @@ Display Strapi relations using readable labels built from your content fields in
 
 Ever wanted to display a relation as custom text or with nested field values? This plugin solves exactly that:
 
-![Relation labels example](assets/example.png)
+![Relation labels example](https://raw.githubusercontent.com/TupiC/strapi-relation-names/main/assets/example.png)
 
 ---
 
@@ -67,32 +67,25 @@ After installing and enabling the plugin, open the Strapi Admin settings panel:
 
 Each relation field is displayed together with the scalar fields available on its related content type or component.
 
-Create a label using placeholders:
+Create a label using placeholders e.g.:
 
 ```text
 {firstName} {lastName}
 ```
 
-For example, given:
-
-```text
-firstName = John
-lastName = Doe
-```
-
-the relation will be displayed as:
+You can also mix placeholders with static text:
 
 ```text
-John Doe
+Name: {firstName} {lastName}
 ```
 
-You can also mix placeholders with static text:
+It is also possible to transform a label's value using pipe syntax:
+{createdAt | toLocalDateTime}
 
-```text
-{firstName} {lastName} ({customerNumber})
-```
+Currently the following transformations exist:
 
-After saving the settings, the Strapi Admin reloads automatically so open Content Manager views use the updated labels.
+- `toLocalDate` — formats date values using the configured locale and time zone.
+- `toLocalDateTime` — formats date-time values using the configured locale and time zone.
 
 ---
 
@@ -100,9 +93,11 @@ After saving the settings, the Strapi Admin reloads automatically so open Conten
 
 Possible configuration keys are listed below; omitted keys keep the plugin defaults.
 
-| Key           | Description                                                                                     | Possible values |
-| ------------- | ----------------------------------------------------------------------------------------------- | --------------- |
-| `collections` | Limit relation names to the listed collection and single type UIDs. Leave empty to include all. | `string[]`      |
+| Key           | Description                                                                                     | Possible values                      |
+| ------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------ |
+| `collections` | Limit relation names to the listed collection and single type UIDs. Leave empty to include all. | `string[]` (default: `[]`)           |
+| `locale`      | Locale used by date transformations.                                                            | `string` (default: runtime locale)   |
+| `timeZone`    | IANA timezone used by date transformations.                                                     | `string` (default: runtime timezone) |
 
 Example:
 
@@ -112,34 +107,14 @@ Example:
   enabled: true,
   config: {
     collections: ['api::article.article', 'api::author.author'],
+    locale: 'de-AT',
+    timeZone: 'Europe/Vienna',
   },
 },
 ```
 
 ---
 
-## ⚙️ Templates
-
-Multiple placeholders can be combined:
-
-```text
-{firstName} {lastName}
-```
-
-Placeholders can also be repeated:
-
-```text
-{name} - {name}
-```
-
-Static text can be included anywhere:
-
-```text
-Customer: {firstName} {lastName}
-```
-
----
-
 ## 🗂️ How It Works
 
 At runtime, the server-side plugin decorates Strapi Content Manager relation responses and field metadata. It reads the configured template, validates each placeholder against the related content type schema, and renders the label from the returned relation data. If a value is not present, it performs a permission-aware hydration query; nested component paths are loaded by populating their component root. The rendered label is then exposed through Strapi's normal relation display mechanism. Missing field values are replaced with an empty string.
@@ -174,7 +149,7 @@ The default label is also used when:
 - [x] Support nested relation fields in templates
 - [ ] Import and export relation-label settings
 - [ ] Conditional labels and configurable fallback rules
-- [ ] Support label transformation functions (e.g., `toUpperCase`, `toLowerCase`, `capitalize`, etc.)
+- [x] Support label transformation functions
 
 If you have any feature requests or suggestions, please open a dedicated issue.
 

package/dist/{admin/SettingsPage-BebR4ghK.js → _chunks/SettingsPage-BMwx-BuP.js}

@@ -6,7 +6,7 @@ const styled = require("styled-components");
 const react = require("react");
 const reactIntl = require("react-intl");
 const admin = require("@strapi/strapi/admin");
-const index = require("./index-DfSAe961.js");
+const index = require("./index-COuIED98.js");
 const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
 const styled__default = /* @__PURE__ */ _interopDefault(styled);
 const FIELD_TYPES = /* @__PURE__ */ new Set([
@@ -24,16 +24,19 @@ const FIELD_TYPES = /* @__PURE__ */ new Set([
   "time",
   "boolean"
 ]);
-const SYSTEM_SCALAR_FIELDS = [
-  "id",
-  "documentId",
-  "createdAt",
-  "updatedAt",
-  "publishedAt",
-  "locale",
-  "status"
-];
-const PLACEHOLDER_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*$/;
+const DATE_TYPES = /* @__PURE__ */ new Set(["date", "datetime"]);
+const SYSTEM_SCALAR_TYPES = {
+  id: "integer",
+  documentId: "string",
+  createdAt: "datetime",
+  updatedAt: "datetime",
+  publishedAt: "datetime",
+  locale: "string",
+  status: "string"
+};
+const SYSTEM_SCALAR_FIELDS = Object.keys(SYSTEM_SCALAR_TYPES);
+const IDENTIFIER_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
+const PATH_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*$/;
 const getNestedSchemaUid = (attribute) => {
   if (attribute.type === "component") {
     return attribute.component;
@@ -43,58 +46,129 @@ const getNestedSchemaUid = (attribute) => {
   }
   return void 0;
 };
-const getPlaceholders = (template) => {
+const getDate = (value) => {
+  if (value instanceof Date) {
+    return Number.isNaN(value.getTime()) ? void 0 : value;
+  }
+  if (typeof value !== "string" && typeof value !== "number") {
+    return void 0;
+  }
+  const date = new Date(value);
+  return Number.isNaN(date.getTime()) ? void 0 : date;
+};
+const isDateOnly = (value) => typeof value === "string" && /^\d{4}-\d{2}-\d{2}$/.test(value);
+const formatDate = (value, options, context, preserveDateOnly) => {
+  const date = getDate(value);
+  if (!date) {
+    return "";
+  }
+  const timeZone = preserveDateOnly && isDateOnly(value) ? "UTC" : context.timeZone;
+  return new Intl.DateTimeFormat(context.locale, {
+    ...options,
+    ...timeZone ? { timeZone } : {}
+  }).format(date);
+};
+const TRANSFORMS = {
+  toLocalDate: {
+    accepts: (fieldType) => DATE_TYPES.has(fieldType ?? ""),
+    apply: (value, context) => formatDate(value, { dateStyle: "short" }, context, true)
+  },
+  toLocalDateTime: {
+    accepts: (fieldType) => fieldType === "datetime",
+    apply: (value, context) => formatDate(value, { dateStyle: "short", timeStyle: "short" }, context, false)
+  }
+};
+const parseExpression = (value) => {
+  const parts = value.split("|").map((part) => part.trim());
+  const [path, ...transforms] = parts;
+  if (!path || !PATH_PATTERN.test(path) || transforms.some((name) => !IDENTIFIER_PATTERN.test(name))) {
+    return null;
+  }
+  return { path, transforms };
+};
+const parseTemplateAst = (template) => {
   if (!template.trim()) {
     return null;
   }
-  const placeholders = [];
-  const matches = template.matchAll(/\{([^{}]*)\}/g);
+  const tokens = [];
+  const expressions = [];
   let cursor = 0;
-  for (const match of matches) {
-    if (match.index !== cursor && template.slice(cursor, match.index).includes("{")) {
+  while (cursor < template.length) {
+    const openingBrace = template.indexOf("{", cursor);
+    const closingBrace = template.indexOf("}", cursor);
+    if (closingBrace !== -1 && (openingBrace === -1 || closingBrace < openingBrace)) {
+      return null;
+    }
+    if (openingBrace === -1) {
+      tokens.push({ type: "text", value: template.slice(cursor) });
+      break;
+    }
+    if (openingBrace > cursor) {
+      tokens.push({ type: "text", value: template.slice(cursor, openingBrace) });
+    }
+    const end = template.indexOf("}", openingBrace + 1);
+    if (end === -1) {
       return null;
     }
-    const name = match[1];
-    if (!PLACEHOLDER_PATTERN.test(name)) {
+    const expression = parseExpression(template.slice(openingBrace + 1, end));
+    if (!expression) {
       return null;
     }
-    placeholders.push(name);
-    cursor = match.index + match[0].length;
+    tokens.push({ type: "expression", expression });
+    expressions.push(expression);
+    cursor = end + 1;
   }
-  if (template.slice(cursor).includes("{") || template.slice(cursor).includes("}")) {
-    return null;
+  return expressions.length > 0 ? { tokens, expressions } : null;
+};
+const resolvePathType = (path, targetSchema, resolveSchema) => {
+  const segments = path.split(".");
+  let schema = targetSchema;
+  for (const [index2, segment] of segments.entries()) {
+    const isLastSegment = index2 === segments.length - 1;
+    if (index2 === 0 && isLastSegment && SYSTEM_SCALAR_TYPES[segment]) {
+      return SYSTEM_SCALAR_TYPES[segment];
+    }
+    const attribute = schema.attributes?.[segment];
+    if (!attribute || attribute.private === true) {
+      return void 0;
+    }
+    if (isLastSegment) {
+      return FIELD_TYPES.has(attribute.type ?? "") ? attribute.type : void 0;
+    }
+    const nestedSchemaUid = getNestedSchemaUid(attribute);
+    if (!nestedSchemaUid || !resolveSchema) {
+      return void 0;
+    }
+    const nestedSchema = resolveSchema(nestedSchemaUid);
+    if (!nestedSchema) {
+      return void 0;
+    }
+    schema = nestedSchema;
   }
-  return placeholders.length > 0 ? placeholders : null;
+  return void 0;
 };
 const validateTemplate = (template, attributes, schemas) => {
-  const placeholders = getPlaceholders(template);
-  if (!placeholders) {
+  const ast = parseTemplateAst(template);
+  if (!ast) {
     return "Use at least one valid {fieldName} placeholder.";
   }
-  const invalidField = placeholders.find((path) => {
-    const segments = path.split(".");
-    let currentAttributes = attributes;
-    for (const [index2, segment] of segments.entries()) {
-      if (index2 === 0 && segments.length === 1 && SYSTEM_SCALAR_FIELDS.includes(segment)) {
-        return false;
-      }
-      const attribute = currentAttributes?.[segment];
-      const isLastSegment = index2 === segments.length - 1;
-      if (!attribute || attribute.private === true) {
-        return true;
-      }
-      if (isLastSegment) {
-        return !FIELD_TYPES.has(attribute.type ?? "");
-      }
-      const nestedSchemaUid = getNestedSchemaUid(attribute);
-      if (!nestedSchemaUid) {
-        return true;
-      }
-      currentAttributes = schemas?.get(nestedSchemaUid)?.attributes;
+  const targetSchema = { attributes };
+  const invalidExpression = ast.expressions.find(({ path, transforms }) => {
+    const fieldType = resolvePathType(path, targetSchema, (uid) => schemas?.get(uid));
+    if (!fieldType) {
+      return true;
     }
-    return true;
+    return transforms.some((name) => !TRANSFORMS[name] || !TRANSFORMS[name].accepts(fieldType));
   });
-  return invalidField ? `“${invalidField}” is not an available scalar field.` : null;
+  if (!invalidExpression) {
+    return null;
+  }
+  const invalidTransform = invalidExpression.transforms.find(
+    (name) => !TRANSFORMS[name] || !TRANSFORMS[name].accepts(
+      resolvePathType(invalidExpression.path, targetSchema, (uid) => schemas?.get(uid))
+    )
+  );
+  return invalidTransform ? `“${invalidTransform}” is not a valid transformation for “${invalidExpression.path}”.` : `“${invalidExpression.path}” is not an available scalar field.`;
 };
 const getAvailableFields = (schema, schemas, prefix = "", ancestors = /* @__PURE__ */ new Set()) => {
   if (!schema) {
@@ -191,7 +265,7 @@ const SettingsPage = () => {
   );
   const updateTemplate = (sourceUid, fieldName, template) => {
     setSettings((current) => {
-      const sourceRelations = { ...current.relations[sourceUid] ?? {} };
+      const sourceRelations = { ...current.relations[sourceUid] };
       if (template.length === 0) {
         delete sourceRelations[fieldName];
       } else {

package/dist/{admin/SettingsPage-DFZP5CZs.mjs → _chunks/SettingsPage-D8leItKF.mjs}

@@ -4,7 +4,7 @@ import styled from "styled-components";
 import { useState, useCallback, useEffect, useMemo, Fragment } from "react";
 import { useIntl } from "react-intl";
 import { useFetchClient } from "@strapi/strapi/admin";
-import { g as getTranslation } from "./index-CiS6cuI9.mjs";
+import { g as getTranslation } from "./index-BeLPoAiU.mjs";
 const FIELD_TYPES = /* @__PURE__ */ new Set([
   "string",
   "text",
@@ -20,16 +20,19 @@ const FIELD_TYPES = /* @__PURE__ */ new Set([
   "time",
   "boolean"
 ]);
-const SYSTEM_SCALAR_FIELDS = [
-  "id",
-  "documentId",
-  "createdAt",
-  "updatedAt",
-  "publishedAt",
-  "locale",
-  "status"
-];
-const PLACEHOLDER_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*$/;
+const DATE_TYPES = /* @__PURE__ */ new Set(["date", "datetime"]);
+const SYSTEM_SCALAR_TYPES = {
+  id: "integer",
+  documentId: "string",
+  createdAt: "datetime",
+  updatedAt: "datetime",
+  publishedAt: "datetime",
+  locale: "string",
+  status: "string"
+};
+const SYSTEM_SCALAR_FIELDS = Object.keys(SYSTEM_SCALAR_TYPES);
+const IDENTIFIER_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
+const PATH_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*(?:\.[A-Za-z_][A-Za-z0-9_]*)*$/;
 const getNestedSchemaUid = (attribute) => {
   if (attribute.type === "component") {
     return attribute.component;
@@ -39,58 +42,129 @@ const getNestedSchemaUid = (attribute) => {
   }
   return void 0;
 };
-const getPlaceholders = (template) => {
+const getDate = (value) => {
+  if (value instanceof Date) {
+    return Number.isNaN(value.getTime()) ? void 0 : value;
+  }
+  if (typeof value !== "string" && typeof value !== "number") {
+    return void 0;
+  }
+  const date = new Date(value);
+  return Number.isNaN(date.getTime()) ? void 0 : date;
+};
+const isDateOnly = (value) => typeof value === "string" && /^\d{4}-\d{2}-\d{2}$/.test(value);
+const formatDate = (value, options, context, preserveDateOnly) => {
+  const date = getDate(value);
+  if (!date) {
+    return "";
+  }
+  const timeZone = preserveDateOnly && isDateOnly(value) ? "UTC" : context.timeZone;
+  return new Intl.DateTimeFormat(context.locale, {
+    ...options,
+    ...timeZone ? { timeZone } : {}
+  }).format(date);
+};
+const TRANSFORMS = {
+  toLocalDate: {
+    accepts: (fieldType) => DATE_TYPES.has(fieldType ?? ""),
+    apply: (value, context) => formatDate(value, { dateStyle: "short" }, context, true)
+  },
+  toLocalDateTime: {
+    accepts: (fieldType) => fieldType === "datetime",
+    apply: (value, context) => formatDate(value, { dateStyle: "short", timeStyle: "short" }, context, false)
+  }
+};
+const parseExpression = (value) => {
+  const parts = value.split("|").map((part) => part.trim());
+  const [path, ...transforms] = parts;
+  if (!path || !PATH_PATTERN.test(path) || transforms.some((name) => !IDENTIFIER_PATTERN.test(name))) {
+    return null;
+  }
+  return { path, transforms };
+};
+const parseTemplateAst = (template) => {
   if (!template.trim()) {
     return null;
   }
-  const placeholders = [];
-  const matches = template.matchAll(/\{([^{}]*)\}/g);
+  const tokens = [];
+  const expressions = [];
   let cursor = 0;
-  for (const match of matches) {
-    if (match.index !== cursor && template.slice(cursor, match.index).includes("{")) {
+  while (cursor < template.length) {
+    const openingBrace = template.indexOf("{", cursor);
+    const closingBrace = template.indexOf("}", cursor);
+    if (closingBrace !== -1 && (openingBrace === -1 || closingBrace < openingBrace)) {
+      return null;
+    }
+    if (openingBrace === -1) {
+      tokens.push({ type: "text", value: template.slice(cursor) });
+      break;
+    }
+    if (openingBrace > cursor) {
+      tokens.push({ type: "text", value: template.slice(cursor, openingBrace) });
+    }
+    const end = template.indexOf("}", openingBrace + 1);
+    if (end === -1) {
       return null;
     }
-    const name = match[1];
-    if (!PLACEHOLDER_PATTERN.test(name)) {
+    const expression = parseExpression(template.slice(openingBrace + 1, end));
+    if (!expression) {
       return null;
     }
-    placeholders.push(name);
-    cursor = match.index + match[0].length;
+    tokens.push({ type: "expression", expression });
+    expressions.push(expression);
+    cursor = end + 1;
   }
-  if (template.slice(cursor).includes("{") || template.slice(cursor).includes("}")) {
-    return null;
+  return expressions.length > 0 ? { tokens, expressions } : null;
+};
+const resolvePathType = (path, targetSchema, resolveSchema) => {
+  const segments = path.split(".");
+  let schema = targetSchema;
+  for (const [index, segment] of segments.entries()) {
+    const isLastSegment = index === segments.length - 1;
+    if (index === 0 && isLastSegment && SYSTEM_SCALAR_TYPES[segment]) {
+      return SYSTEM_SCALAR_TYPES[segment];
+    }
+    const attribute = schema.attributes?.[segment];
+    if (!attribute || attribute.private === true) {
+      return void 0;
+    }
+    if (isLastSegment) {
+      return FIELD_TYPES.has(attribute.type ?? "") ? attribute.type : void 0;
+    }
+    const nestedSchemaUid = getNestedSchemaUid(attribute);
+    if (!nestedSchemaUid || !resolveSchema) {
+      return void 0;
+    }
+    const nestedSchema = resolveSchema(nestedSchemaUid);
+    if (!nestedSchema) {
+      return void 0;
+    }
+    schema = nestedSchema;
   }
-  return placeholders.length > 0 ? placeholders : null;
+  return void 0;
 };
 const validateTemplate = (template, attributes, schemas) => {
-  const placeholders = getPlaceholders(template);
-  if (!placeholders) {
+  const ast = parseTemplateAst(template);
+  if (!ast) {
     return "Use at least one valid {fieldName} placeholder.";
   }
-  const invalidField = placeholders.find((path) => {
-    const segments = path.split(".");
-    let currentAttributes = attributes;
-    for (const [index, segment] of segments.entries()) {
-      if (index === 0 && segments.length === 1 && SYSTEM_SCALAR_FIELDS.includes(segment)) {
-        return false;
-      }
-      const attribute = currentAttributes?.[segment];
-      const isLastSegment = index === segments.length - 1;
-      if (!attribute || attribute.private === true) {
-        return true;
-      }
-      if (isLastSegment) {
-        return !FIELD_TYPES.has(attribute.type ?? "");
-      }
-      const nestedSchemaUid = getNestedSchemaUid(attribute);
-      if (!nestedSchemaUid) {
-        return true;
-      }
-      currentAttributes = schemas?.get(nestedSchemaUid)?.attributes;
+  const targetSchema = { attributes };
+  const invalidExpression = ast.expressions.find(({ path, transforms }) => {
+    const fieldType = resolvePathType(path, targetSchema, (uid) => schemas?.get(uid));
+    if (!fieldType) {
+      return true;
     }
-    return true;
+    return transforms.some((name) => !TRANSFORMS[name] || !TRANSFORMS[name].accepts(fieldType));
   });
-  return invalidField ? `“${invalidField}” is not an available scalar field.` : null;
+  if (!invalidExpression) {
+    return null;
+  }
+  const invalidTransform = invalidExpression.transforms.find(
+    (name) => !TRANSFORMS[name] || !TRANSFORMS[name].accepts(
+      resolvePathType(invalidExpression.path, targetSchema, (uid) => schemas?.get(uid))
+    )
+  );
+  return invalidTransform ? `“${invalidTransform}” is not a valid transformation for “${invalidExpression.path}”.` : `“${invalidExpression.path}” is not an available scalar field.`;
 };
 const getAvailableFields = (schema, schemas, prefix = "", ancestors = /* @__PURE__ */ new Set()) => {
   if (!schema) {
@@ -187,7 +261,7 @@ const SettingsPage = () => {
   );
   const updateTemplate = (sourceUid, fieldName, template) => {
     setSettings((current) => {
-      const sourceRelations = { ...current.relations[sourceUid] ?? {} };
+      const sourceRelations = { ...current.relations[sourceUid] };
       if (template.length === 0) {
         delete sourceRelations[fieldName];
       } else {

package/dist/{admin/index-CiS6cuI9.mjs → _chunks/index-BeLPoAiU.mjs}

@@ -88,7 +88,7 @@ const plugin = {
         id: `${PLUGIN_ID}.plugin.name`,
         defaultMessage: "Relation Names"
       },
-      Component: () => import("./SettingsPage-DFZP5CZs.mjs").then((module) => ({ default: module.SettingsPage })),
+      Component: () => import("./SettingsPage-D8leItKF.mjs").then((module) => ({ default: module.SettingsPage })),
       permissions: []
     });
     app.registerPlugin({

package/dist/{admin/index-DfSAe961.js → _chunks/index-COuIED98.js}

@@ -89,7 +89,7 @@ const plugin = {
         id: `${PLUGIN_ID}.plugin.name`,
         defaultMessage: "Relation Names"
       },
-      Component: () => Promise.resolve().then(() => require("./SettingsPage-BebR4ghK.js")).then((module2) => ({ default: module2.SettingsPage })),
+      Component: () => Promise.resolve().then(() => require("./SettingsPage-BMwx-BuP.js")).then((module2) => ({ default: module2.SettingsPage })),
       permissions: []
     });
     app.registerPlugin({

package/dist/admin/index.js

@@ -1,4 +1,3 @@
 "use strict";
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
-const index = require("./index-DfSAe961.js");
-exports.default = index.plugin;
+const index = require("../_chunks/index-COuIED98.js");
+module.exports = index.plugin;

package/dist/admin/index.mjs

@@ -1,4 +1,4 @@
-import { p } from "./index-CiS6cuI9.mjs";
+import { p } from "../_chunks/index-BeLPoAiU.mjs";
 export {
   p as default
 };

package/dist/admin/src/index.d.ts

@@ -1,3 +1,3 @@
-import { StrapiApp } from '@strapi/strapi/admin';
+import type { StrapiApp } from '@strapi/strapi/admin';
 declare const plugin: StrapiApp['appPlugins'][string];
 export default plugin;

package/dist/admin/src/pages/SettingsPage.d.ts

@@ -1,2 +1,3 @@
+/// <reference types="react" />
 declare const SettingsPage: () => import("react").JSX.Element;
 export { SettingsPage };

package/dist/admin/src/utils/template.d.ts

@@ -1,14 +1 @@
-type TemplateAttribute = {
-    type?: string;
-    component?: string;
-    target?: string;
-    targetModel?: string;
-    private?: boolean;
-};
-type TemplateSchema = {
-    attributes?: Record<string, TemplateAttribute>;
-};
-declare const getPlaceholders: (template: string) => string[] | null;
-declare const validateTemplate: (template: string, attributes: Record<string, TemplateAttribute> | undefined, schemas?: ReadonlyMap<string, TemplateSchema>) => string | null;
-declare const getAvailableFields: (schema: TemplateSchema | undefined, schemas: ReadonlyMap<string, TemplateSchema>, prefix?: string, ancestors?: Set<string>) => string[];
-export { getAvailableFields, getPlaceholders, validateTemplate };
+export { getAvailableFields, getPlaceholders, validateTemplate } from '../../../shared/template';