feat: Index fields

cypress/e2e/index_fields_spec.js

@@ -0,0 +1,80 @@
+import '../utils/dismiss-local-backup';
+import {
+  login,
+  createPostAndPublish,
+  assertPublishedEntry,
+} from '../utils/steps';
+
+const indexFileEntry = {
+  title: 'Index Page',
+  body: 'This is the index page content.',
+};
+
+const regularEntry = {
+  title: 'Regular Post',
+  body: 'This is a regular post content.',
+};
+
+const backend = 'test';
+
+describe('Index File Feature', () => {
+  before(() => {
+    Cypress.config('defaultCommandTimeout', 4000);
+    cy.task('setupBackend', { backend, options: { publish_mode: 'simple' } });
+  });
+
+  after(() => {
+    cy.task('teardownBackend', { backend });
+  });
+
+  it('successfully loads with index file configured', () => {
+    login();
+  });
+
+  it('can create and publish an index file entry', () => {
+    login();
+    createPostAndPublish(indexFileEntry);
+    assertPublishedEntry(indexFileEntry);
+  });
+
+  it('can create and publish a regular entry alongside index file', () => {
+    login();
+    createPostAndPublish(regularEntry);
+    assertPublishedEntry(regularEntry);
+  });
+
+  it('displays correct entry type in list when index file exists', () => {
+    login();
+    // Verify that entries list loads and displays both regular and index entries
+    cy.contains('a', 'New Post');
+    cy.get('[data-testid="list-control"]').should('exist');
+  });
+
+  it('can distinguish between index and regular entries in editor', () => {
+    login();
+    // Navigate to entries list
+    cy.contains('a', 'Writing in').click();
+    // Should see entries listed
+    cy.get('[class*="entrylist"]').should('exist');
+  });
+
+  it('can edit and republish index file entry', () => {
+    login();
+    createPostAndPublish(indexFileEntry);
+
+    // Navigate to entries list
+    cy.contains('a', 'Writing in').click();
+    cy.contains(indexFileEntry.title).click();
+
+    // Update content
+    const updatedTitle = 'Updated Index Page';
+    cy.get('input[name="title"]').clear();
+    cy.get('input[name="title"]').type(updatedTitle);
+    cy.get('textarea[name="body"]').clear();
+    cy.get('textarea[name="body"]').type('Updated index content.');
+
+    // Publish changes
+    cy.contains('button', 'Publish').click();
+    cy.contains('Published to').should('exist');
+  });
+});

dev-test/backends/test/config.yml

@@ -33,6 +33,13 @@ collections: # A list of collections the CMS should be able to edit
         pattern: \d{4}
       - label: Drafts
         field: draft
+    index_file:
+      pattern: _index
+      editor:
+        preview: false
+      fields: 
+        - { label: 'Title', name: 'title', widget: 'string', tagname: 'h1' }
+        - { label: 'Body', name: 'body', widget: 'markdown', hint: 'Main content goes here.' }
     fields: # The fields each document in this collection have
       - { label: 'Title', name: 'title', widget: 'string', tagname: 'h1' }
       - { label: 'Draft', name: 'draft', widget: 'boolean', default: false }

dev-test/backends/test/index.html

@@ -7,6 +7,9 @@
   <script>
   window.repoFiles = {
     _posts: {
+      "_index.md": {
+        content: "---\ntitle: Posts list page\n---\n\nThis is a list of dummy posts\n"
+      },
       "2015-02-14-this-is-a-post.md": {
         content: "---\ntitle: This is a YAML front matter post\nimage: /nf-logo.png\ndate: 2015-02-14T00:00:00.000Z\n---\n\n# I Am a Title in Markdown\n\nHello, world\n\n* One Thing\n* Another Thing\n* A Third Thing\n"
       },

dev-test/config.yml

@@ -39,6 +39,13 @@ collections: # A list of collections the CMS should be able to edit
         pattern: \d{4}
       - label: Drafts
         field: draft
+    index_file:
+      pattern: _index
+      editor:
+        preview: false
+      fields: 
+        - { label: 'Title', name: 'title', widget: 'string', tagname: 'h1' }
+        - { label: 'Body', name: 'body', widget: 'markdown', hint: 'Main content goes here.' }
     fields: # The fields each document in this collection have
       - { label: 'Title', name: 'title', widget: 'string', tagname: 'h1' }
       - { label: 'Draft', name: 'draft', widget: 'boolean', default: false }

dev-test/index.html

@@ -7,6 +7,9 @@
   <script>
   window.repoFiles = {
     _posts: {
+      "_index.md": {
+        content: "---\ntitle: Posts list page\n---\n\nThis is a list of dummy posts\n"
+      },
       "2015-02-14-this-is-a-post.md": {
         content: "---\ntitle: This is a YAML front matter post\nimage: /nf-logo.png\ndate: 2015-02-14T00:00:00.000Z\n---\n\n# I Am a Title in Markdown\n\nHello, world\n\n* One Thing\n* Another Thing\n* A Third Thing\n"
       },

packages/decap-cms-backend-github/src/API.ts

@@ -1415,32 +1415,41 @@ export default class API {
 
   async updateTree(
     baseSha: string,
-    files: { path: string; sha: string | null; newPath?: string }[],
+    files: { path: string; sha: string | null; newPath?: string; isFolder?: boolean }[],
     branch = this.branch,
   ) {
-    const toMove: { from: string; to: string; sha: string }[] = [];
+    const toMove: { from: string; to: string; sha: string; isFolder?: boolean }[] = [];
     const tree = files.reduce((acc, file) => {
       const entry = {
         path: trimStart(file.path, '/'),
         mode: '100644',
         type: 'blob',
         sha: file.sha,
+        isFolder: file.isFolder,
       } as TreeEntry;
 
       if (file.newPath) {
-        toMove.push({ from: file.path, to: file.newPath, sha: file.sha as string });
+        toMove.push({
+          from: file.path,
+          to: file.newPath,
+          sha: file.sha as string,
+          isFolder: file.isFolder,
+        });
       } else {
         acc.push(entry);
       }
 
       return acc;
     }, [] as TreeEntry[]);
 
-    for (const { from, to, sha } of toMove) {
+    for (const { from, to, sha, isFolder } of toMove) {
       const sourceDir = dirname(from);
       const destDir = dirname(to);
       const files = await this.listFiles(sourceDir, { branch, depth: 100 });
       for (const file of files) {
+        if (isFolder === false && file.path !== from) {
+          continue;
+        }
         // delete current path
         tree.push({
           path: file.path,

packages/decap-cms-core/index.d.ts

@@ -194,6 +194,7 @@ declare module 'decap-cms-core' {
     multiple?: boolean;
     min?: number;
     max?: number;
+    meta?: boolean;
   }
 
   export interface CmsFieldRelation {
@@ -342,6 +343,11 @@ declare module 'decap-cms-core' {
     view_filters?: ViewFilter[];
     view_groups?: ViewGroup[];
     i18n?: boolean | CmsI18nConfig;
+    index_file?: {
+      pattern: string;
+      editor?: { preview?: boolean };
+      fields?: CmsField[];
+    };
 
     /**
      * @deprecated Use sortable_fields instead

packages/decap-cms-core/src/__tests__/backend.spec.js

@@ -460,7 +460,7 @@ describe('Backend', () => {
         partial: false,
         raw: '---\ntitle: "Hello World"\n---\n',
         data: { title: 'Hello World' },
-        meta: { path: 'src/posts/index.md' },
+        meta: { path: 'src/posts/index.md', path_type: 'slug' },
         i18n: {},
         label: null,
         isModification: true,

packages/decap-cms-core/src/actions/__tests__/entries.spec.js

@@ -519,7 +519,7 @@ describe('entries', () => {
       expect(selectCustomPath).toHaveBeenCalledTimes(1);
       expect(selectCustomPath).toHaveBeenCalledWith(
         collection,
-        fromJS({ entry: { meta: { path: 'existing-path' } } }),
+        fromJS({ entry: { meta: { path: 'existing-path', path_type: 'index' } } }),
       );
 
       expect(selectEntryByPath).toHaveBeenCalledTimes(1);

packages/decap-cms-core/src/actions/config.ts

@@ -23,10 +23,13 @@ import type {
   CmsFieldBase,
   CmsFieldObject,
   CmsFieldList,
+  CmsFieldSelect,
+  CmsFieldMeta,
   CmsI18nConfig,
   CmsPublishMode,
   CmsLocalBackend,
   State,
+  CmsCollectionMeta,
 } from '../types/redux';
 
 export const CONFIG_REQUEST = 'CONFIG_REQUEST';
@@ -228,6 +231,39 @@ export function normalizeConfig(config: CmsConfig) {
   return { ...config, collections: normalizedCollections };
 }
 
+function applyMetaFieldsToCollection(collection: CmsCollection, meta: CmsCollectionMeta) {
+  const metaFields: CmsFieldBase[] = [
+    {
+      name: 'path',
+      meta: true,
+      required: true,
+      i18n: 'duplicate',
+      default: '/',
+      ...meta!.path,
+    } as CmsFieldMeta,
+  ];
+
+  if (collection.index_file) {
+    metaFields.push({
+      name: 'path_type',
+      meta: true,
+      required: true,
+      widget: 'select',
+      readonly: true,
+      i18n: 'duplicate',
+      label: 'Path type',
+      options: ['index', 'slug'],
+      default: 'slug',
+    } as CmsFieldBase & CmsFieldSelect);
+  }
+
+  collection.fields = [...metaFields, ...(collection.fields || [])];
+
+  if (collection.index_file?.fields) {
+    collection.index_file.fields = [...metaFields, ...(collection.index_file.fields || [])];
+  }
+}
+
 export function applyDefaults(originalConfig: CmsConfig) {
   return produce(originalConfig, config => {
     config.publish_mode = config.publish_mode || SIMPLE_PUBLISH_MODE;
@@ -287,6 +323,13 @@ export function applyDefaults(originalConfig: CmsConfig) {
         collection.fields = setI18nDefaultsForFields(collection.fields, Boolean(collectionI18n));
       }
 
+      if (collection.index_file?.fields) {
+        collection.index_file.fields = setI18nDefaultsForFields(
+          collection.index_file.fields,
+          Boolean(collectionI18n),
+        );
+      }
+
       const { folder, files, view_filters, view_groups, meta } = collection;
 
       if (folder) {
@@ -308,13 +351,7 @@ export function applyDefaults(originalConfig: CmsConfig) {
         collection.folder = trim(folder, '/');
 
         if (meta && meta.path) {
-          const metaField = {
-            name: 'path',
-            meta: true,
-            required: true,
-            ...meta.path,
-          };
-          collection.fields = [metaField, ...(collection.fields || [])];
+          applyMetaFieldsToCollection(collection, meta);
         }
       }
 

packages/decap-cms-core/src/actions/entries.ts

@@ -16,11 +16,11 @@ import { SortDirection } from '../types/redux';
 import { waitForMediaLibraryToLoad, loadMedia } from './mediaLibrary';
 import { waitUntil } from './waitUntil';
 import { selectIsFetching, selectEntriesSortFields, selectEntryByPath } from '../reducers/entries';
-import { selectCustomPath } from '../reducers/entryDraft';
 import { navigateToEntry } from '../routing/history';
 import { getProcessSegment } from '../lib/formatters';
 import { hasI18n, duplicateDefaultI18nFields, serializeI18n, I18N, I18N_FIELD } from '../lib/i18n';
 import { addNotification } from './notifications';
+import { selectCustomPath } from '../reducers/entryDraft';
 
 import type { ImplementationMediaFile } from 'decap-cms-lib-util';
 import type { AnyAction } from 'redux';
@@ -34,6 +34,7 @@ import type {
   ViewFilter,
   ViewGroup,
   Entry,
+  Entries,
 } from '../types/redux';
 import type { EntryValue } from '../valueObjects/Entry';
 import type { Backend } from '../backend';
@@ -389,7 +390,8 @@ export function draftDuplicateEntry(entry: EntryMap) {
     type: DRAFT_CREATE_DUPLICATE_FROM_ENTRY,
     payload: createEntry(entry.get('collection'), '', '', {
       data: entry.get('data'),
-      i18n: entry.get('i18n'),
+      meta: entry.get('meta').toJS(),
+      i18n: entry.get('i18n').toJS(),
       mediaFiles: entry.get('mediaFiles').toJS(),
     }),
   };
@@ -1019,6 +1021,19 @@ function getPathError(
   };
 }
 
+function getExistingEntry(
+  entries: Entries,
+  collection: Collection,
+  path: string,
+  path_type: string,
+) {
+  const customPath = selectCustomPath(collection, fromJS({ entry: { meta: { path, path_type } } }));
+  if (!customPath) {
+    return undefined;
+  }
+  return selectEntryByPath(entries, collection.get('name'), customPath);
+}
+
 export function validateMetaField(
   state: State,
   collection: Collection,
@@ -1039,11 +1054,9 @@ export function validateMetaField(
       return getPathError(value, 'invalidPath', t);
     }
 
-    const customPath = selectCustomPath(collection, fromJS({ entry: { meta: { path: value } } }));
-    const existingEntry = customPath
-      ? selectEntryByPath(state.entries, collection.get('name'), customPath)
-      : undefined;
-
+    const existingEntry =
+      getExistingEntry(state.entries, collection, value, 'index') ??
+      getExistingEntry(state.entries, collection, value, 'slug');
     const existingEntryPath = existingEntry?.get('path');
     const draftPath = state.entryDraft?.getIn(['entry', 'path']);