@easy-cms/core 0.11.0 → 0.12.0

package/dist/index.d.ts

@@ -211,6 +211,8 @@ interface BaseField<TType extends string, TValue> {
      * hasMany fields: localize the fields inside a group or array instead.
      */
     readonly localized?: boolean;
+    /** `sidebar`: shown in the edit page's side panel instead of the main form (top-level fields). */
+    readonly position?: 'sidebar';
 }
 interface TextField extends BaseField<'text', string> {
     readonly minLength?: number;
@@ -436,6 +438,12 @@ interface CollectionConfig {
     };
     /** Icon in the admin menu. Default `file-text`. */
     readonly icon?: AdminIcon;
+    /**
+     * How the admin opens documents from the list: `drawer` slides a panel over the list, handy
+     * for small collections (categories, tags). Default `page`. Collections with drafts, versions
+     * or live preview always use the page.
+     */
+    readonly editIn?: 'page' | 'drawer';
     readonly fields: readonly Field[];
     /** Top-level field shown as the document title in the admin UI. */
     readonly useAsTitle?: string;
@@ -490,6 +498,16 @@ interface AdminConfig {
     readonly locale?: AdminLocale;
     /** Name, logo and color of the admin UI. */
     readonly brand?: AdminBrand;
+    /**
+     * The public site, for the admin's "View site" link: a path (`/`) or an `https://` URL.
+     * Default `/` with Nuxt and Next.js; none with the standalone server.
+     */
+    readonly siteUrl?: string;
+    /**
+     * Order of collections in the admin menu, by slug, e.g. `['posts', 'categories', 'media']`.
+     * Collections not listed follow in config order, with the media library last.
+     */
+    readonly menu?: readonly string[];
 }
 interface ImageSize {
     /** Key in `media.sizes`, e.g. `thumbnail`. */
@@ -1378,6 +1396,8 @@ interface AdminField {
     readOnly?: boolean;
     /** One value per content locale. */
     localized?: boolean;
+    /** Shown in the edit page's side panel. */
+    position?: 'sidebar';
 }
 interface AdminCollection {
     slug: string;
@@ -1387,6 +1407,8 @@ interface AdminCollection {
     };
     icon?: string;
     useAsTitle?: string;
+    /** Documents open in a panel over the list. */
+    editIn?: 'drawer';
     drafts: boolean;
     versions: boolean;
     /** Has live preview (`preview` in the config). */
@@ -1419,6 +1441,8 @@ interface AdminGlobal {
 }
 interface AdminSchema {
     locale: AdminLocale;
+    /** Menu order of collections (`admin.menu`); unlisted ones follow. */
+    menu: string[];
     /** Content locales, when the config has `localization`. */
     localization: {
         locales: string[];

package/dist/index.js

@@ -1279,6 +1279,17 @@ function validateConfig(config) {
     const slug = checkSlug(collection2, `collections[${i}]`, seenCollections, add);
     if (slug) collectionSlugs.add(slug);
   });
+  const menu = config.admin?.menu;
+  if (menu !== void 0) {
+    if (!Array.isArray(menu)) {
+      add("admin.menu", "must be an array of collection slugs", "e.g. menu: ['posts', 'media']");
+    } else {
+      for (const [i, slug] of menu.entries()) {
+        if (typeof slug !== "string" || !collectionSlugs.has(slug))
+          add(`admin.menu[${i}]`, `unknown collection ${JSON.stringify(slug)}`);
+      }
+    }
+  }
   const seenGlobals = /* @__PURE__ */ new Set();
   globals.forEach((global2, i) => {
     checkSlug(global2, `globals[${i}]`, seenGlobals, add);
@@ -1288,6 +1299,9 @@ function validateConfig(config) {
     validateContainer(collection2, path, collectionSlugs, add);
     validateUseAsTitle(collection2, path, add);
     validateIcon(collection2, path, add);
+    const editIn = collection2.editIn;
+    if (editIn !== void 0 && editIn !== "page" && editIn !== "drawer")
+      add(`${path}.editIn`, `must be "page" or "drawer" (got ${JSON.stringify(editIn)})`);
   });
   globals.forEach((global2, i) => {
     const path = `globals.${global2.slug ?? `[${i}]`}`;
@@ -1321,6 +1335,14 @@ function validateAdmin(config, add) {
   if (admin.locale !== void 0 && admin.locale !== "en" && admin.locale !== "th") {
     add("admin.locale", `must be "en" or "th" (got ${JSON.stringify(admin.locale)})`);
   }
+  const siteUrl = admin.siteUrl;
+  if (siteUrl !== void 0 && (typeof siteUrl !== "string" || !/^(\/|https?:\/\/)/.test(siteUrl))) {
+    add(
+      "admin.siteUrl",
+      'must be a path starting with "/" or an http(s) URL',
+      "e.g. siteUrl: 'https://example.com'"
+    );
+  }
   const brand = admin.brand;
   if (brand === void 0) return;
   if (typeof brand !== "object" || brand === null) {
@@ -1595,6 +1617,10 @@ function validateFields2(fields, path, reserved, collectionSlugs, add) {
   }
 }
 function validateField(field, path, siblings, collectionSlugs, add) {
+  const position = field.position;
+  if (position !== void 0 && position !== "sidebar") {
+    add(`${path}.position`, `must be "sidebar" (got ${JSON.stringify(position)})`);
+  }
   switch (field.type) {
     case "text":
     case "textarea":
@@ -1745,7 +1771,9 @@ async function resolveConfig(input) {
     admin: {
       path: config.admin?.path ?? DEFAULT_ADMIN_PATH,
       locale: config.admin?.locale ?? "en",
-      brand: config.admin?.brand ?? {}
+      brand: config.admin?.brand ?? {},
+      siteUrl: config.admin?.siteUrl ?? "",
+      menu: config.admin?.menu ?? []
     },
     upload: {
       dir: config.upload?.dir ?? "uploads",
@@ -3646,6 +3674,7 @@ async function serializeFields(fields, update, localized) {
     if (field.defaultValue !== void 0) f.defaultValue = field.defaultValue;
     if (!await update.allows(field)) f.readOnly = true;
     if (field.localized && localized) f.localized = true;
+    if (field.position === "sidebar") f.position = "sidebar";
     switch (field.type) {
       case "text":
       case "textarea":
@@ -3718,6 +3747,8 @@ async function collection(config, user, localized) {
   if (config.labels) result.labels = config.labels;
   if (config.useAsTitle) result.useAsTitle = config.useAsTitle;
   if (config.icon) result.icon = config.icon;
+  if (config.editIn === "drawer" && !result.drafts && !result.versions && !result.preview)
+    result.editIn = "drawer";
   return result;
 }
 async function global(config, user, localized) {
@@ -3747,6 +3778,7 @@ async function adminSchema(cms, user) {
   const localized = localization !== null;
   return {
     locale: cms.config.admin.locale,
+    menu: [...cms.config.admin.menu],
     localization: localization ? { locales: [...localization.locales], defaultLocale: localization.defaultLocale } : null,
     collections: await Promise.all(collections.map((c) => collection(c, user, localized))),
     globals: await Promise.all(cms.config.globals.map((g) => global(g, user, localized)))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easy-cms/core",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Embedded, code-first headless CMS for Nuxt and Next.js",
   "license": "MIT",
   "type": "module",