refactor collection metadata

Author: odama626

packages/core/src/generators/schema.ts

@@ -1,6 +1,6 @@
 import { schemaComposer } from 'graphql-compose';
 import { composeWithJson } from 'graphql-compose-json';
-import { defaultsDeep, merge } from 'lodash-es';
+import { defaultsDeep, get, merge } from 'lodash-es';
 import plur from 'plur';
 import { VFile } from 'vfile';
 
@@ -59,7 +59,17 @@ export async function generateSchema(
         defaultsDeep(
           {},
           getFieldOverrides(collection, config),
-          ...nodes.map((node) => merge({}, node, preknownSchemaFragments))
+          ...nodes.map((node) =>
+            merge(
+              {
+                _flatbread: {
+                  reference: get(node, node?._flatbread?.referenceField),
+                },
+              },
+              node,
+              preknownSchemaFragments
+            )
+          )
         ),
         { schemaComposer }
       ),
@@ -170,11 +180,9 @@ const fetchPreknownSchemaFragments = (
 
 function getTransformerExtensionMap(transformer: Transformer[]) {
   const transformerMap = new Map();
-  transformer.forEach((t) => {
-    t.extensions.forEach((extension) => {
-      transformerMap.set(extension, t);
-    });
-  });
+  transformer.forEach((t) =>
+    t.extensions.forEach((extension) => transformerMap.set(extension, t))
+  );
   return transformerMap;
 }
 

packages/core/src/types.ts

@@ -23,13 +23,13 @@ export type ContentNode = BaseContentNode & {
 export interface FlatbreadConfig {
   source: Source;
   transformer?: Transformer | Transformer[];
-  content: Content;
+  content: Partial<CollectionEntry>[];
 }
 
 export interface LoadedFlatbreadConfig {
   source: Source;
   transformer: Transformer[];
-  content: Content;
+  content: CollectionEntry[];
   loaded: {
     extensions: string[];
   };
@@ -69,9 +69,8 @@ export type EntryNode = Record<string, any>;
  */
 export interface Source {
   initialize?: (flatbreadConfig: LoadedFlatbreadConfig) => void;
-  fetchByType?: (path: string) => Promise<any[]>;
   fetch: (
-    allContentTypes: Record<string, any>[]
+    allContentTypes: CollectionEntry[]
   ) => Promise<Record<string, VFile[]>>;
 }
 
@@ -93,12 +92,14 @@ export interface Override {
 }
 
 /**
- * An array of content descriptions which can be used to retrieve content nodes.
+ * A collection entry which can be used to retrieve content nodes.
  *
  * This is paired with a `Source` (and, *optionally*, a `Transformer`) plugin.
  */
-export type Content = {
+export interface CollectionEntry {
   collection: string;
   overrides?: Override[];
+  referenceField: string;
+
   [key: string]: any;
-}[];
+}

packages/core/src/utils/initializeConfig.ts

@@ -1,3 +1,5 @@
+import { defaultsDeep } from 'lodash-es';
+import { CollectionEntry } from '../../dist';
 import { LoadedFlatbreadConfig, Transformer } from '../types';
 
 export function initializeConfig(config: any): LoadedFlatbreadConfig {
@@ -10,5 +12,10 @@ export function initializeConfig(config: any): LoadedFlatbreadConfig {
       .map((transformer: Transformer) => transformer.extensions || [])
       .flat(),
   };
+
+  config.content = config.content?.map((content: CollectionEntry) =>
+    defaultsDeep(content, { referenceField: 'id' })
+  );
+
   return config;
 }

packages/source-filesystem/package.json

@@ -41,6 +41,7 @@
   },
   "devDependencies": {
     "@flatbread/core": "workspace:*",
+    "@sindresorhus/slugify": "^2.1.0",
     "@types/lodash-es": "4.17.6",
     "@types/node": "16.11.47",
     "tsup": "6.2.1",

packages/source-filesystem/src/index.ts

@@ -1,7 +1,12 @@
-import { defaultsDeep } from 'lodash-es';
+import slugify from '@sindresorhus/slugify';
+import { defaultsDeep, merge } from 'lodash-es';
 import { read } from 'to-vfile';
 
-import type { LoadedFlatbreadConfig, SourcePlugin } from '@flatbread/core';
+import type {
+  CollectionEntry,
+  LoadedFlatbreadConfig,
+  SourcePlugin,
+} from '@flatbread/core';
 import type { VFile } from 'vfile';
 import type {
   FileNode,
@@ -18,16 +23,27 @@ import gatherFileNodes from './utils/gatherFileNodes';
  * @returns An array of content nodes
  */
 async function getNodesFromDirectory(
-  path: string,
+  collectionEntry: CollectionEntry,
   config: InitializedSourceFilesystemConfig
 ): Promise<VFile[]> {
   const { extensions } = config;
-  const nodes: FileNode[] = await gatherFileNodes(path, { extensions });
+  const nodes: FileNode[] = await gatherFileNodes(collectionEntry.path, {
+    extensions,
+  });
 
   return Promise.all(
     nodes.map(async (node: FileNode): Promise<VFile> => {
       const file = await read(node.path);
-      file.data = node.data;
+      file.data = merge(node.data, {
+        _flatbread: {
+          referenceField: collectionEntry.referenceField,
+          collection: collectionEntry.collection,
+          filename: file.basename,
+          path: file.path,
+          slug: slugify(file.stem ?? ''),
+        },
+      });
+
       return file;
     })
   );
@@ -40,16 +56,16 @@ async function getNodesFromDirectory(
  * @returns
  */
 async function getAllNodes(
-  allContentTypes: Record<string, any>[],
+  allCollectionEntries: CollectionEntry[],
   config: InitializedSourceFilesystemConfig
 ): Promise<Record<string, VFile[]>> {
   const nodeEntries = await Promise.all(
-    allContentTypes.map(
+    allCollectionEntries.map(
       async (contentType): Promise<Record<string, any>> =>
         new Promise(async (res) =>
           res([
             contentType.collection,
-            await getNodesFromDirectory(contentType.path, config),
+            await getNodesFromDirectory(contentType, config),
           ])
         )
     )
@@ -76,9 +92,7 @@ const source: SourcePlugin = (sourceConfig?: sourceFilesystemConfig) => {
       const { extensions } = flatbreadConfig.loaded;
       config = defaultsDeep(sourceConfig ?? {}, { extensions });
     },
-    fetchByType: (path: string) => getNodesFromDirectory(path, config),
-    fetch: (allContentTypes: Record<string, any>[]) =>
-      getAllNodes(allContentTypes, config),
+    fetch: (content: CollectionEntry[]) => getAllNodes(content, config),
   };
 };
 

packages/transformer-markdown/package.json

@@ -35,7 +35,6 @@
     "node": "^14.13.1 || >=16.0.0"
   },
   "dependencies": {
-    "@sindresorhus/slugify": "^2.1.0",
     "graphql": "16.5.0",
     "gray-matter": "^4.0.3",
     "lodash-es": "^4.17.21",

packages/transformer-markdown/src/index.ts

@@ -1,10 +1,9 @@
 import matter from 'gray-matter';
-import slugify from '@sindresorhus/slugify';
-import { html, excerpt, timeToRead } from './graphql/schema-helpers';
+import { excerpt, html, timeToRead } from './graphql/schema-helpers';
 
-import type { MarkdownTransformerConfig } from './types';
 import type { EntryNode, TransformerPlugin } from '@flatbread/core';
 import type { VFile } from 'vfile';
+import type { MarkdownTransformerConfig } from './types';
 
 export * from './types';
 
@@ -20,9 +19,6 @@ export const parse = (
 ): EntryNode => {
   const { data, content } = matter(String(input), config.grayMatter);
   return {
-    _filename: input.basename,
-    _path: input.path,
-    _slug: slugify(input.stem ?? ''),
     ...input.data,
     ...data,
     _content: {

packages/transformer-yaml/package.json

@@ -35,7 +35,6 @@
     "node": "^14.13.1 || >=16.0.0"
   },
   "dependencies": {
-    "@sindresorhus/slugify": "^2.1.0",
     "js-yaml": "^4.1.0"
   },
   "devDependencies": {

packages/transformer-yaml/src/index.ts

@@ -1,7 +1,6 @@
-import yaml from 'js-yaml';
-import type { YAMLException } from 'js-yaml';
-import slugify from '@sindresorhus/slugify';
 import type { EntryNode, TransformerPlugin } from '@flatbread/core';
+import type { YAMLException } from 'js-yaml';
+import yaml from 'js-yaml';
 import { VFile } from 'vfile';
 
 /**
@@ -18,9 +17,6 @@ export const parse = (input: VFile): EntryNode => {
 
   if (typeof doc === 'object') {
     return {
-      _filename: input.basename,
-      _path: input.path,
-      _slug: slugify(input.stem ?? ''),
       ...input.data,
       ...doc,
     };

packages/transformer-yaml/src/tests/snapshots/index.test.ts.md

@@ -9,9 +9,6 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     {
-      _filename: undefined,
-      _path: undefined,
-      _slug: '',
       date_joined: Date 2021-02-25 16:41:59 558ms UTC {},
       enjoys: [
         'cats',