Refactors plugin for improved modularity and schema handling

Removes legacy entry points and updates exports for direct usage from source files.
Refactors transformer API to use context-based collection and processing of nodes, enabling more flexible and accurate schema customization.
Adds enhanced logging for debugging and clarity.
Simplifies build configuration and package exports to streamline module format and type declaration output.
Improves transformer logic for handling markdown images and associated file nodes.

Author: alexcmgit

gatsby-node.ts

@@ -23,8 +23,7 @@
   },
   "license": "MIT",
   "author": "@libsrcdev",
-  "type": "module",
-  "main": "./dist/index.cjs",
+  "main": "./dist/index.js",
   "files": [
     "dist"
   ],
@@ -57,19 +56,5 @@
     "semi": true,
     "singleQuote": true,
     "trailingComma": "es5"
-  },
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.cts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
-    },
-    "./gatsby-node": {
-      "import": "./dist/gatsby-node.mjs",
-      "require": "./dist/gatsby-node.cjs"
-    },
-    "./package.json": "./package.json",
-    "./foo": "./foo.js"
   }
 }

package.json

@@ -5,11 +5,14 @@ interface StructuredContentPluginOptions {
   transformers?: RemarkStructuredContentTransformer[];
 }
 
-export default async function createSchemaCustomization(
+export async function createSchemaCustomization(
   gatsbyNodeApis: CreateSchemaCustomizationArgs,
   pluginOptions: StructuredContentPluginOptions
 ): Promise<void> {
-  const { actions } = gatsbyNodeApis;
+  const { actions, reporter } = gatsbyNodeApis;
+
+  reporter.info("Starting createSchemaCustomization in remark-structured-content plugin");
+
   const { createTypes } = actions;
 
   const typeDefs = `
@@ -29,7 +32,7 @@ export default async function createSchemaCustomization(
   if (callbacks && callbacks.length > 0) {
     for (const callback of callbacks) {
       // Allow each transformer to extend types
-      await callback({ actions: gatsbyNodeApis.actions });
+      await callback({ ...gatsbyNodeApis });
     }
   }
 }

src/create-schema-customization.ts

@@ -2,30 +2,37 @@ import { createRemoteFileNode } from "gatsby-source-filesystem";
 import { visit, EXIT } from "unist-util-visit";
 import type { Node as UnistNode, Parent as UnistParent } from "unist";
 import type { Image } from "mdast";
-import { RemarkPluginApi, RemarkStructuredContentTransformer, StructuredContentPluginOptions as RemarkStructuredContentPluginOptions, TransformerContext } from "./types.ts";
-
+import { RemarkPluginApi, RemarkStructuredContentTransformer, StructuredContentPluginOptions as RemarkStructuredContentPluginOptions, TransformerContext } from "./types";
 
 /**
  * Extract ALL images from the markdown AST and save them to File nodes.
  */
 export function createImageExtractorTransformer(): RemarkStructuredContentTransformer<Image> {
   return {
-    createSchemaCustomization: ({ actions }) => {
+    createSchemaCustomization: ({ reporter, actions, schema }) => {
       const { createTypes } = actions;
-      const typeDefs = `
+
+      reporter.info("Creating schema customization for createImageExtractorTransformer");
+
+      const typeDefs = [
+        `
         type MarkdownRemark implements Node {
-          embeddedImages: [File!] @link(by: "parent.id", from: "id")
+          embeddedImages: [File] @link(by: "fields.imageExtractedFromMarkdownRemarkId", from: "id")
         }
-      `;
+      `,
+      ]
+
       createTypes(typeDefs);
     },
     traverse: (markdownAST, _utils, context) => {
       getAllImagesFromMarkdownAST(markdownAST).forEach((imageNode) => {
-        context.scheduleTransformOf(imageNode);
+        context.collect(imageNode);
       });
     },
-    transform: async (node, { saveNodeToFile }) => {
-      await saveNodeToFile(node, { transformer: true });
+    transform: async (context, { createFileNode }, { markdownNode: markdownRemarkGatsbyNode }) => {
+      for (const node of context.collected) {
+        await createFileNode(node, { imageExtractedFromMarkdownRemarkId: markdownRemarkGatsbyNode.id });
+      }
     },
   };
 }
@@ -37,13 +44,17 @@ export type CreateThumbnailImageTransformerOptions = {
 /**
  * Extract a single "thumbnail" image with special rules, then remove it from the AST.
  */
-export function createThumbnailImageTransformer({ keepImageInMdAST }: CreateThumbnailImageTransformerOptions): RemarkStructuredContentTransformer<Image> {
+export function createThumbnailImageTransformer(options?: CreateThumbnailImageTransformerOptions): RemarkStructuredContentTransformer<Image> {
+  const { keepImageInMdAST } = options || {};
+
+  const LINK_FIELD_NAME = "thumbnailImage";
+
   return {
-    createSchemaCustomization: ({ actions }) => {
+    createSchemaCustomization: ({ actions, schema }) => {
       const { createTypes } = actions;
       const typeDefs = `
         type MarkdownRemark implements Node {
-          thumbnailImage: File @link(by: "parent.id", from: "id")
+          ${LINK_FIELD_NAME}: File @link(from: "fields.${LINK_FIELD_NAME}", by: "id")
         }
       `;
       createTypes(typeDefs);
@@ -52,16 +63,29 @@ export function createThumbnailImageTransformer({ keepImageInMdAST }: CreateThum
       const thumbImgNode = getThumbnailImageOnly(markdownAST);
 
       if (thumbImgNode) {
-        context.scheduleTransformOf(thumbImgNode);
+        context.collect(thumbImgNode);
       }
     },
-    transform: async (node, { saveNodeToFile, removeNodeFromMdAST }) => {
-      await saveNodeToFile(node, { isThumbnail: true });
+    transform: async (context, { createFileNode, removeNodeFromMdAST }, gatsbyApis) => {
+      const { markdownNode: markdownRemarkGatsbyNode, actions } = gatsbyApis;
+
+      const [thumbMdASTNode] = context.collected;
+
+      if (!thumbMdASTNode) {
+        // No thumbnail image found
+        return;
+      }
+
+      const { createNodeField } = actions;
+
+      const thumbImgGatsbyNode = await createFileNode(thumbMdASTNode);
+
+      createNodeField({ node: markdownRemarkGatsbyNode, name: LINK_FIELD_NAME, value: thumbImgGatsbyNode.id });
 
       if (keepImageInMdAST === true) {
         // do nothing, keep the node in the AST
       } else {
-        await removeNodeFromMdAST(node);
+        await removeNodeFromMdAST(thumbMdASTNode);
       }
     },
   };
@@ -79,17 +103,22 @@ export default async function remarkStructuredContentPlugin(
     markdownNode,
     getCache,
     actions,
+    reporter,
     createNodeId,
     ...rest
   } = remarkPluginApi;
 
+  reporter.info("Starting remark-structured-content plugin for a markdown node with id: " + markdownNode.id);
+
   const { createNode, createNodeField } = actions;
   const { transformers } = pluginOptions;
 
-  async function saveNodeToFile(
+  async function createFileNode(
     node: Image,
     extraFields: Record<string, unknown> = {}
   ) {
+    reporter.info(`Saving remote file node for image: ${node.url}`);
+
     const fileNode = await createRemoteFileNode({
       url: node.url,
       parentNodeId: markdownNode.id,
@@ -98,8 +127,10 @@ export default async function remarkStructuredContentPlugin(
       createNodeId,
     });
 
+    reporter.info(`Created file node with id: ${fileNode?.id} for image: ${node.url}`);
+
     for (const [key, value] of Object.entries(extraFields)) {
-      await createNodeField({ node: fileNode, name: key, value });
+      createNodeField({ node: fileNode, name: key, value });
     }
 
     return fileNode;
@@ -115,20 +146,19 @@ export default async function remarkStructuredContentPlugin(
   for (const transformer of transformers) {
     const context: TransformerContext<any> = {
       collected: [],
-      scheduleTransformOf(item) {
+      collect(item) {
         this.collected.push(item);
       },
+      meta: {},
     };
 
     transformer.traverse(markdownAST, { visit }, context);
 
-    for (const collectedItem of context.collected) {
-      await transformer.transform(
-        collectedItem,
-        { saveNodeToFile, removeNodeFromMdAST },
-        remarkPluginApi
-      );
-    }
+    await transformer.transform(
+      context,
+      { createFileNode, removeNodeFromMdAST },
+      remarkPluginApi,
+    );
   }
 
   return markdownAST;
@@ -157,6 +187,8 @@ function getThumbnailImageOnly(markdownAST: UnistNode): Image | null {
     markdownAST,
     "image",
     (node, index, parent) => {
+      thumbnailImage = node as Image;
+      return [EXIT];
       if (!parent || typeof index !== "number") {
         return;
       }
@@ -174,10 +206,15 @@ function getThumbnailImageOnly(markdownAST: UnistNode): Image | null {
 
       if (!hasTextBefore && !hasTextAfter) {
         thumbnailImage = node as Image;
-        return EXIT;
+        return [EXIT];
       }
     }
   );
 
   return thumbnailImage;
 }
+
+export { sourceNodes } from "./source-nodes";
+export { onCreateNode } from "./on-create-node";
+export { createSchemaCustomization } from "./create-schema-customization";
+export { pluginOptionsSchema } from "./plugin-options-schema";

src/index.ts

@@ -5,7 +5,7 @@ interface StructuredContentPluginOptions extends PluginOptions {
   // transformers?: Transformer[];
 }
 
-export default async function onCreateNode(
+export async function onCreateNode(
   ...args: [CreateNodeArgs, StructuredContentPluginOptions]
 ): Promise<void> {
   const [

src/on-create-node.ts

@@ -1,6 +1,6 @@
 import type { PluginOptionsSchemaArgs } from "gatsby";
 
-export default function pluginOptionsSchema(
+export function pluginOptionsSchema(
   { Joi }: PluginOptionsSchemaArgs
 ) {
   return Joi.object({});

src/plugin-options-schema.ts

@@ -1,7 +1,7 @@
 import type { SourceNodesArgs, PluginOptions } from "gatsby";
-import { RemarkPluginApi } from "./types.ts";
+import { RemarkPluginApi } from "./types";
 
-export default async function sourceNodes(
+export async function sourceNodes(
   gatsbyArgs: SourceNodesArgs,
   pluginOptions: RemarkPluginApi
 ): Promise<void> {

src/source-nodes.ts

@@ -1,26 +1,26 @@
-import type { Actions, PluginOptions } from "gatsby";
+import type { Actions, CreateSchemaCustomizationArgs, PluginOptions } from "gatsby";
 import { visit, EXIT } from "unist-util-visit";
 import type { Node as UnistNode, Parent as UnistParent } from "unist";
 import type { Image } from "mdast";
 
 export interface RemarkStructuredContentTransformer<T = any> {
-  createSchemaCustomization?: (args: { actions: Actions }) => void | Promise<void>;
+  createSchemaCustomization?: (args: CreateSchemaCustomizationArgs) => void | Promise<void>;
   traverse: (
     markdownAST: UnistNode,
     utils: { visit: typeof visit },
     context: TransformerContext<T>
   ) => void;
   transform: (
-    collected: T,
+    context: TransformerContext<T>,
     helpers: {
-      saveNodeToFile: (node: Image, extraFields?: Record<string, unknown>) => Promise<any>;
+      createFileNode: (node: Image, extraFields?: Record<string, unknown>) => Promise<any>;
       removeNodeFromMdAST: (node: UnistNode) => Promise<void>;
     },
     api: RemarkPluginApi
   ) => Promise<void>;
 }
 
-export interface RemarkPluginApi {
+export interface RemarkPluginApi extends CreateSchemaCustomizationArgs {
   markdownAST: UnistNode;
   markdownNode: any;
   getCache: (id: string) => any;
@@ -32,7 +32,8 @@ export interface RemarkPluginApi {
 
 export interface TransformerContext<T = any> {
   collected: T[];
-  scheduleTransformOf: (item: T) => void;
+  collect: (item: T) => void;
+  meta: Record<string, unknown>;
 }
 
 export interface StructuredContentPluginOptions extends PluginOptions {

src/types.ts

@@ -1,15 +1,13 @@
 {
-  "include": ["src", "types", "test", "gatsby-node.ts"],
+  "include": ["src", "types", "test"],
   "compilerOptions": {
     "target": "es5",
-    "module": "nodenext",
+    "module": "esnext",
     "lib": ["dom", "esnext"],
     "importHelpers": true,
     "declaration": true,
     "sourceMap": true,
     "rootDir": "./",
-    "allowImportingTsExtensions": true,
-    "noEmit": true,
     "strict": true,
     "noImplicitAny": true,
     "strictNullChecks": true,
@@ -21,7 +19,7 @@
     "noUnusedParameters": true,
     "noImplicitReturns": true,
     "noFallthroughCasesInSwitch": true,
-    "moduleResolution": "nodenext",
+    "moduleResolution": "node",
     "baseUrl": "./",
     "paths": {
       "*": ["src/*", "node_modules/*"]

tsconfig.json

@@ -2,11 +2,19 @@ import { defineConfig } from "tsdown";
 
 export default defineConfig({
   entry: {
-    "gatsby-node": "gatsby-node.ts",
     "index": "src/index.ts",
   },
-  format: ["cjs", "esm"],
+  format: ["cjs"],
   dts: true,
+  outExtensions: (c) => {
+    if (c.format === "cjs") {
+      return {
+        js: ".js",
+        dts: ".d.ts",
+      };
+    }
+    return undefined;
+  },
   clean: true,
   platform: "node",
   unbundle: false,