@lightnet/sveltia-admin 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lightnet/sveltia-admin
 
+## 4.2.0
+
+### Minor Changes
+
+- [#425](https://github.com/LightNetDev/LightNet/pull/425) [`d21b3c1`](https://github.com/LightNetDev/LightNet/commit/d21b3c18fe5368555be56015625632b391c29dd8) - Added summaryLocale config option to support choosing the language for entry summaries.
+
 ## 4.1.0
 
 ### Minor Changes

package/package.json

@@ -3,7 +3,7 @@
   "description": "Admin UI for LightNet based on Sveltia CMS.",
   "type": "module",
   "license": "MIT",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "publishConfig": {
     "access": "public"
   },

package/src/astro-integration/config.ts

@@ -167,6 +167,16 @@ export const adminConfigSchema = z.object({
        * @default true
        */
       showSlugField: z.boolean().default(true),
+      /**
+       * Set the language used for entry summaries.
+       *
+       * The value must match the `code` of one site language configured for this site.
+       * Make sure all entry labels include a translation for this language.
+       *
+       * @example "en"
+       */
+      summaryLocale: z.string().optional(),
+
       /**
        * Use Cloudflare r2 for content uploads.
        */

package/src/collections/categories.ts

@@ -1,9 +1,8 @@
 import type { Collection } from "@sveltia/cms"
-import config from "virtual:lightnet/config"
 import adminConfig from "virtual:lightnet/sveltiaAdminConfig"
 
 import { projectPath } from "../utils/paths"
-import { inlineTranslation } from "./fields/inline-translation"
+import { inlineTranslation, translatedLabel } from "./fields/inline-translation"
 
 export const categoriesCollection: Collection = {
   name: "categories",
@@ -17,8 +16,8 @@ export const categoriesCollection: Collection = {
   format: "json",
   slug: adminConfig.experimental.showSlugField
     ? "{{fields._slug}}"
-    : `{{label.${config.defaultLocale}}}`,
-  summary: `{{label.${config.defaultLocale}}}`,
+    : translatedLabel(),
+  summary: translatedLabel(),
   fields: [
     inlineTranslation({ name: "label", label: "Name" }),
     {

package/src/collections/fields/inline-translation.ts

@@ -1,10 +1,13 @@
 import type { Field, ObjectField } from "@sveltia/cms"
 import config from "virtual:lightnet/config"
+import adminConfig from "virtual:lightnet/sveltiaAdminConfig"
 
 type Options = Partial<ObjectField> & {
   name: string
 }
 
+const summaryLocale = adminConfig.experimental.summaryLocale
+
 const locales = [
   config.defaultLocale,
   ...config.locales.filter((l) => l !== config.defaultLocale),
@@ -14,12 +17,17 @@ const locales = [
 }))
 
 export const inlineTranslation = (options: Options): Field => ({
-  summary: `{{${config.defaultLocale}}}`,
+  summary: `{{${summaryLocale ?? config.defaultLocale}}}`,
   ...options,
   widget: "object",
   fields: locales.map((locale) => ({
     ...locale,
     widget: "string",
-    required: locale.name === config.defaultLocale,
+    required:
+      locale.name === config.defaultLocale || locale.name === summaryLocale,
   })),
 })
+
+export const translatedLabel = (fieldName = "label") => {
+  return `{{${fieldName}.${summaryLocale ?? config.defaultLocale}}}`
+}

package/src/collections/languages.ts

@@ -5,6 +5,8 @@ import adminConfig from "virtual:lightnet/sveltiaAdminConfig"
 import { projectPath } from "../utils/paths"
 import { inlineTranslation } from "./fields/inline-translation"
 
+const { summaryLocale } = adminConfig.experimental
+
 export const languagesSelect = () => {
   const commonProperties = {
     name: "language",
@@ -20,7 +22,7 @@ export const languagesSelect = () => {
       file: "languages",
       value_field: "{{languages.*.code}}",
       display_fields: [
-        `{{languages.*.label.${config.defaultLocale}}} ({{languages.*.code}})`,
+        `{{languages.*.label.${summaryLocale ?? config.defaultLocale}}} ({{languages.*.code}})`,
       ],
     }
   } else {
@@ -29,7 +31,7 @@ export const languagesSelect = () => {
       widget: "select",
       options: config.languages.map(({ code, label }) => {
         return {
-          label: `${label[config.defaultLocale]} (${code})`,
+          label: `${label[summaryLocale ?? config.defaultLocale]} (${code})`,
           value: code,
         }
       }),
@@ -60,7 +62,7 @@ const languagesCollection: CollectionFile = {
       allow_reorder: false,
       root: true,
       collapsed: "auto",
-      summary: `{{label.${config.defaultLocale}}}  ({{code}})`,
+      summary: `{{label.${summaryLocale ?? config.defaultLocale}}}  ({{code}})`,
       fields: [
         {
           name: "code",

package/src/collections/media-collections.ts

@@ -1,9 +1,8 @@
 import type { Collection } from "@sveltia/cms"
-import config from "virtual:lightnet/config"
 import adminConfig from "virtual:lightnet/sveltiaAdminConfig"
 
 import { projectPath } from "../utils/paths"
-import { inlineTranslation } from "./fields/inline-translation"
+import { inlineTranslation, translatedLabel } from "./fields/inline-translation"
 
 export const mediaCollectionCollection: Collection = {
   name: "media-collections",
@@ -17,8 +16,8 @@ export const mediaCollectionCollection: Collection = {
   format: "json",
   slug: adminConfig.experimental.showSlugField
     ? "{{fields._slug}}"
-    : `{{label.${config.defaultLocale}}}`,
-  summary: `{{label.${config.defaultLocale}}}`,
+    : translatedLabel(),
+  summary: translatedLabel(),
   fields: [
     inlineTranslation({
       name: "label",

package/src/collections/media-items.ts

@@ -4,7 +4,7 @@ import adminConfig from "virtual:lightnet/sveltiaAdminConfig"
 
 import { isDefined } from "../utils/is-defined"
 import { projectPath } from "../utils/paths"
-import { inlineTranslation } from "./fields/inline-translation"
+import { inlineTranslation, translatedLabel } from "./fields/inline-translation"
 import { languagesSelect } from "./languages"
 
 export const mediaItemCollection: Collection = {
@@ -38,7 +38,7 @@ export const mediaItemCollection: Collection = {
       widget: "relation",
       hint: "Choose the kind of media this content represents.",
       collection: "media-types",
-      display_fields: [`{{label.${config.defaultLocale}}} ({{slug}})`],
+      display_fields: [translatedLabel()],
     },
     languagesSelect(),
     {
@@ -145,7 +145,7 @@ export const mediaItemCollection: Collection = {
       widget: "relation",
       multiple: true,
       collection: "categories",
-      display_fields: [`{{label.${config.defaultLocale}}}`],
+      display_fields: [translatedLabel()],
     },
     {
       name: "description",

package/src/collections/media-types.ts

@@ -1,9 +1,8 @@
 import type { Collection } from "@sveltia/cms"
-import config from "virtual:lightnet/config"
 import adminConfig from "virtual:lightnet/sveltiaAdminConfig"
 
 import { projectPath } from "../utils/paths"
-import { inlineTranslation } from "./fields/inline-translation"
+import { inlineTranslation, translatedLabel } from "./fields/inline-translation"
 
 export const mediaTypeCollection: Collection = {
   name: "media-types",
@@ -16,8 +15,8 @@ export const mediaTypeCollection: Collection = {
   hide: adminConfig.experimental.hideMediaTypesCollection,
   slug: adminConfig.experimental.showSlugField
     ? "{{fields._slug}}"
-    : `{{label.${config.defaultLocale}}}`,
-  summary: `{{label.${config.defaultLocale}}}`,
+    : translatedLabel(),
+  summary: translatedLabel(),
   fields: [
     inlineTranslation({ name: "label", label: "Name" }),
     {

package/src/config.json.ts

@@ -1,7 +1,26 @@
 import type { APIRoute } from "astro"
+import { AstroError } from "astro/errors"
+import config from "virtual:lightnet/config"
+import adminConfig from "virtual:lightnet/sveltiaAdminConfig"
 
 import { createConfig } from "./sveltia.config"
 
 export const GET: APIRoute = () => {
+  validateAdminConfig()
   return new Response(JSON.stringify(createConfig()))
 }
+
+/**
+ * When validating the admin config structure in integration.ts, we do not
+ * have access to the resolved LightNet config. This function acts as a hook
+ * for more detailed validation that depends on the resolved LightNet config.
+ */
+const validateAdminConfig = () => {
+  const { summaryLocale } = adminConfig.experimental
+  if (summaryLocale && !config.locales.includes(summaryLocale)) {
+    throw new AstroError(
+      "Invalid summaryLocale",
+      `summaryLocale must match one of your site languages: ${JSON.stringify(config.locales)}.`,
+    )
+  }
+}