add more metadata to collection

Author: odama626

examples/sveltekit/src/routes/index.svelte

@@ -4,9 +4,9 @@
       query PostCategory {
         allPostCategories (sortBy: "title", order: DESC) {
           _flatbread {
-            _filename
-            _collection
-            _slug
+            filename
+            collection
+            slug
           }
           id
           title
@@ -20,7 +20,9 @@
             timeToRead
           }
           authors {
-            _slug
+            _flatbread {
+              slug
+            }
             id
             name
             entity

packages/core/src/generators/schema.ts

@@ -59,17 +59,7 @@ export async function generateSchema(
         defaultsDeep(
           {},
           getFieldOverrides(collection, config),
-          ...nodes.map((node) =>
-            merge(
-              {
-                _flatbread: {
-                  reference: get(node, node?._flatbread?.referenceField),
-                },
-              },
-              node,
-              preknownSchemaFragments
-            )
-          )
+          ...nodes.map((node) => merge({}, node, preknownSchemaFragments))
         ),
         { schemaComposer }
       ),
@@ -213,7 +203,11 @@ const optionallyTransformContentNodes = (
       if (!transformer?.parse) {
         throw new Error(`no transformer found for ${node.path}`);
       }
-      return transformer.parse(node);
+      console.log({ transformer });
+      const doc = transformer.parse(node);
+      doc._flatbread.transformedBy = transformer.id;
+      doc._flatbread.reference = get(doc, doc._flatbread.referenceField);
+      return doc;
     });
   }
 

packages/core/src/types.ts

@@ -51,6 +51,7 @@ export interface Transformer {
    * @param input Node to transform
    */
   parse?: (input: VFile) => EntryNode;
+  id?: string;
   preknownSchemaFragments?: () => Record<string, any>;
   inspect: (input: EntryNode) => string;
   extensions: string[];
@@ -69,6 +70,7 @@ export type EntryNode = Record<string, any>;
  */
 export interface Source {
   initialize?: (flatbreadConfig: LoadedFlatbreadConfig) => void;
+  id?: string;
   fetch: (
     allContentTypes: CollectionEntry[]
   ) => Promise<Record<string, VFile[]>>;

packages/core/src/utils/initializeConfig.ts

@@ -2,6 +2,8 @@ import { cloneDeep, defaultsDeep } from 'lodash-es';
 import { CollectionEntry } from '../types';
 import { FlatbreadConfig, LoadedFlatbreadConfig, Transformer } from '../types';
 import { toArray } from './arrayUtils';
+import { createHash } from 'crypto';
+import { anyToString } from './stringUtils';
 
 /**
  * Processes a config object and returns a normalized version of it.
@@ -10,7 +12,10 @@ export function initializeConfig(
   rawConfig: FlatbreadConfig
 ): LoadedFlatbreadConfig {
   const config = cloneDeep(rawConfig);
-  const transformer = toArray(config.transformer ?? []);
+  const transformer = toArray(config.transformer ?? []).map((t) => {
+    t.id = t.id ?? createHash('sha256').update(anyToString(t)).digest('hex');
+    return t;
+  });
 
   return {
     ...config,

packages/source-filesystem/src/index.ts

@@ -1,12 +1,13 @@
 import slugify from '@sindresorhus/slugify';
 import { defaultsDeep, merge } from 'lodash-es';
 import { read } from 'to-vfile';
-
+import ownPackage from '../package.json';
 import type {
   CollectionEntry,
   LoadedFlatbreadConfig,
   SourcePlugin,
 } from '@flatbread/core';
+import { relative } from 'path';
 import type { VFile } from 'vfile';
 import type {
   FileNode,
@@ -39,8 +40,9 @@ async function getNodesFromDirectory(
           referenceField: collectionEntry.referenceField,
           collection: collectionEntry.collection,
           filename: file.basename,
-          path: file.path,
+          path: relative(process.cwd(), file.path),
           slug: slugify(file.stem ?? ''),
+          sourcedBy: ownPackage.name,
         },
       });
 

packages/transformer-markdown/src/index.ts

@@ -1,5 +1,6 @@
 import matter from 'gray-matter';
 import { excerpt, html, timeToRead } from './graphql/schema-helpers';
+import ownPackage from '../package.json';
 
 import type { EntryNode, TransformerPlugin } from '@flatbread/core';
 import type { VFile } from 'vfile';
@@ -41,6 +42,7 @@ export const transformer: TransformerPlugin = (
   );
   return {
     parse: (input: VFile): EntryNode => parse(input, config),
+    id: ownPackage.name,
     preknownSchemaFragments: () => ({
       _content: {
         html: html(config),

packages/transformer-yaml/src/index.ts

@@ -2,6 +2,7 @@ import type { EntryNode, TransformerPlugin } from '@flatbread/core';
 import type { YAMLException } from 'js-yaml';
 import yaml from 'js-yaml';
 import { VFile } from 'vfile';
+import ownPackage from '../package.json';
 
 /**
  * Transforms a yaml file (content node) to JSON.
@@ -42,6 +43,7 @@ export const transformer: TransformerPlugin = () => {
   return {
     parse: (input: VFile): EntryNode => parse(input),
     inspect: (input: EntryNode) => String(input),
+    id: ownPackage.name,
     serialize,
     extensions: ['.yaml', '.yml'],
   };