@astrojs/markdoc 0.3.1 → 0.3.3

package/README.md

@@ -151,9 +151,8 @@ import Heading from './src/components/Heading.astro';
 export default defineMarkdocConfig({
   nodes: {
     heading: {
+      ...nodes.heading, // Preserve default anchor link generation
       render: Heading,
-      // Preserve default anchor link generation
-      ...nodes.heading,
     },
   },
 })
@@ -225,8 +224,8 @@ import { defineMarkdocConfig, nodes } from '@astrojs/markdoc/config';
 export default defineMarkdocConfig({
   nodes: {
     document: {
-      render: null, // default 'article'
       ...nodes.document, // Apply defaults for other options
+      render: null, // default 'article'
     },
   },
 })
@@ -246,9 +245,8 @@ import Quote from './src/components/Quote.astro';
 export default defineMarkdocConfig({
   nodes: {
     blockquote: {
+      ...nodes.blockquote, // Apply Markdoc's defaults for other options
       render: Quote,
-      // Apply Markdoc's defaults for other options
-      ...nodes.blockquote,
     },
   },
 })

package/components/Renderer.astro

@@ -15,4 +15,10 @@ const ast = Markdoc.Ast.fromJSON(stringifiedAst);
 const content = Markdoc.transform(ast, config);
 ---
 
-<ComponentNode treeNode={await createTreeNode(content)} />
+{
+	Array.isArray(content) ? (
+		content.map(async (c) => <ComponentNode treeNode={await createTreeNode(c)} />)
+	) : (
+		<ComponentNode treeNode={await createTreeNode(content)} />
+	)
+}

package/components/TreeNode.ts

@@ -1,5 +1,4 @@
 import type { AstroInstance } from 'astro';
-import { Fragment } from 'astro/jsx-runtime';
 import type { RenderableTreeNode } from '@markdoc/markdoc';
 import Markdoc from '@markdoc/markdoc';
 import {
@@ -106,18 +105,11 @@ export const ComponentNode = createComponent({
 	propagation: 'self',
 });
 
-export async function createTreeNode(node: RenderableTreeNode | RenderableTreeNode[]): TreeNode {
+export async function createTreeNode(node: RenderableTreeNode): Promise<TreeNode> {
 	if (isHTMLString(node)) {
 		return { type: 'text', content: node as HTMLString };
 	} else if (typeof node === 'string' || typeof node === 'number') {
 		return { type: 'text', content: String(node) };
-	} else if (Array.isArray(node)) {
-		return {
-			type: 'component',
-			component: Fragment,
-			props: {},
-			children: await Promise.all(node.map((child) => createTreeNode(child))),
-		};
 	} else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) {
 		return { type: 'text', content: '' };
 	}
@@ -136,7 +128,7 @@ export async function createTreeNode(node: RenderableTreeNode | RenderableTreeNo
 		};
 	} else if (isPropagatedAssetsModule(node.name)) {
 		const { collectedStyles, collectedLinks, collectedScripts } = node.name;
-		const component = (await node.name.getMod())?.default ?? Fragment;
+		const component = (await node.name.getMod()).default;
 		const props = node.attributes;
 
 		return {
@@ -160,7 +152,7 @@ export async function createTreeNode(node: RenderableTreeNode | RenderableTreeNo
 
 type PropagatedAssetsModule = {
 	__astroPropagation: true;
-	getMod: () => Promise<AstroInstance['default']>;
+	getMod: () => Promise<AstroInstance>;
 	collectedStyles: string[];
 	collectedLinks: string[];
 	collectedScripts: string[];

package/dist/config.d.ts

@@ -1,36 +1,40 @@
-import type { ConfigType as MarkdocConfig } from '@markdoc/markdoc';
+import type { Config, ConfigType as MarkdocConfig, MaybePromise, NodeType, Schema } from '@markdoc/markdoc';
 import _Markdoc from '@markdoc/markdoc';
-export type AstroMarkdocConfig<C extends Record<string, any> = Record<string, any>> = MarkdocConfig & {
-    ctx?: C;
-    extends?: ResolvedAstroMarkdocConfig[];
-};
+import type { AstroInstance } from 'astro';
+type Render = AstroInstance['default'] | string;
+export type AstroMarkdocConfig<C extends Record<string, any> = Record<string, any>> = Omit<MarkdocConfig, 'tags' | 'nodes'> & Partial<{
+    tags: Record<string, Schema<Config, Render>>;
+    nodes: Partial<Record<NodeType, Schema<Config, Render>>>;
+    ctx: C;
+    extends: MaybePromise<ResolvedAstroMarkdocConfig>[];
+}>;
 export type ResolvedAstroMarkdocConfig = Omit<AstroMarkdocConfig, 'extends'>;
 export declare const Markdoc: typeof _Markdoc;
 export declare const nodes: {
-    heading: import("@markdoc/markdoc").Schema;
-    document: import("@markdoc/markdoc").Schema;
-    paragraph: import("@markdoc/markdoc").Schema;
-    image: import("@markdoc/markdoc").Schema;
-    fence: import("@markdoc/markdoc").Schema;
-    blockquote: import("@markdoc/markdoc").Schema;
-    item: import("@markdoc/markdoc").Schema;
-    list: import("@markdoc/markdoc").Schema;
-    hr: import("@markdoc/markdoc").Schema;
-    table: import("@markdoc/markdoc").Schema;
-    td: import("@markdoc/markdoc").Schema;
-    th: import("@markdoc/markdoc").Schema;
-    tr: import("@markdoc/markdoc").Schema;
-    tbody: import("@markdoc/markdoc").Schema;
-    thead: import("@markdoc/markdoc").Schema;
-    strong: import("@markdoc/markdoc").Schema;
-    em: import("@markdoc/markdoc").Schema;
-    s: import("@markdoc/markdoc").Schema;
-    inline: import("@markdoc/markdoc").Schema;
-    link: import("@markdoc/markdoc").Schema;
-    code: import("@markdoc/markdoc").Schema;
-    text: import("@markdoc/markdoc").Schema;
-    hardbreak: import("@markdoc/markdoc").Schema;
-    softbreak: import("@markdoc/markdoc").Schema;
+    heading: Schema;
+    document: Schema;
+    paragraph: Schema;
+    image: Schema;
+    fence: Schema;
+    blockquote: Schema;
+    item: Schema;
+    list: Schema;
+    hr: Schema;
+    table: Schema;
+    td: Schema;
+    th: Schema;
+    tr: Schema;
+    tbody: Schema;
+    thead: Schema;
+    strong: Schema;
+    em: Schema;
+    s: Schema;
+    inline: Schema;
+    link: Schema;
+    code: Schema;
+    text: Schema;
+    hardbreak: Schema;
+    softbreak: Schema;
     comment: {
         attributes: {
             content: {
@@ -43,3 +47,4 @@ export declare const nodes: {
     node: {};
 };
 export declare function defineMarkdocConfig(config: AstroMarkdocConfig): AstroMarkdocConfig;
+export {};

package/dist/heading-ids.d.ts

@@ -1,9 +1,10 @@
-import { type Schema } from '@markdoc/markdoc';
+import { type Config as MarkdocConfig, type Schema } from '@markdoc/markdoc';
 import Slugger from 'github-slugger';
-import type { AstroMarkdocConfig } from './config.js';
-type HeadingIdConfig = AstroMarkdocConfig<{
-    headingSlugger: Slugger;
-}>;
+type HeadingIdConfig = MarkdocConfig & {
+    ctx: {
+        headingSlugger: Slugger;
+    };
+};
 export declare const heading: Schema;
 export declare function setupHeadingConfig(): HeadingIdConfig;
 export {};

package/dist/index.js

@@ -1,8 +1,8 @@
 import Markdoc from "@markdoc/markdoc";
+import crypto from "node:crypto";
 import fs from "node:fs";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import {
-  createNameHash,
   hasContentFlag,
   isValidUrl,
   MarkdocError,
@@ -68,7 +68,11 @@ function markdocIntegration(legacyConfig) {
             const pluginContext = this;
             const markdocConfig = await setupConfig(userMarkdocConfig);
             const filePath = fileURLToPath(fileUrl);
-            const validationErrors = Markdoc.validate(ast, markdocConfig).filter((e) => {
+            const validationErrors = Markdoc.validate(
+              ast,
+              /* Raised generics issue with Markdoc core https://github.com/markdoc/markdoc/discussions/400 */
+              markdocConfig
+            ).filter((e) => {
               return (
                 // Ignore `variable-undefined` errors.
                 // Variables can be configured at runtime,
@@ -235,6 +239,16 @@ async function emitOptimizedImages(nodeChildren, ctx) {
 function shouldOptimizeImage(src) {
   return !isValidUrl(src) && !src.startsWith("/");
 }
+function createNameHash(baseId, hashIds) {
+  const baseName = baseId ? path.parse(baseId).name : "index";
+  const hash = crypto.createHash("sha256");
+  for (const id of hashIds) {
+    hash.update(id, "utf-8");
+  }
+  const h = hash.digest("hex").slice(0, 8);
+  const proposedName = baseName + "." + h;
+  return proposedName;
+}
 export {
   markdocIntegration as default
 };

package/dist/load-config.d.ts

@@ -1,7 +1,7 @@
-import type { Config as MarkdocConfig } from '@markdoc/markdoc';
 import type { AstroConfig } from 'astro';
+import type { AstroMarkdocConfig } from './config.js';
 export type MarkdocConfigResult = {
-    config: MarkdocConfig;
+    config: AstroMarkdocConfig;
     fileUrl: URL;
 };
 export declare function loadMarkdocConfig(astroConfig: Pick<AstroConfig, 'root'>): Promise<MarkdocConfigResult | undefined>;

package/dist/utils.d.ts

@@ -46,9 +46,4 @@ export declare const PROPAGATED_ASSET_FLAG = "astroPropagatedAssets";
  * @see 'packages/astro/src/content/utils.ts'
  */
 export declare function hasContentFlag(viteId: string, flag: string): boolean;
-/**
- * Create build hash for manual Rollup chunks.
- * @see 'packages/astro/src/core/build/plugins/plugin-css.ts'
- */
-export declare function createNameHash(baseId: string, hashIds: string[]): string;
 export {};

package/dist/utils.js

@@ -1,6 +1,4 @@
 import matter from "gray-matter";
-import crypto from "node:crypto";
-import path from "node:path";
 function parseFrontmatter(fileContents, filePath) {
   try {
     matter.clearCache();
@@ -59,20 +57,9 @@ function hasContentFlag(viteId, flag) {
   const flags = new URLSearchParams(viteId.split("?")[1] ?? "");
   return flags.has(flag);
 }
-function createNameHash(baseId, hashIds) {
-  const baseName = baseId ? path.parse(baseId).name : "index";
-  const hash = crypto.createHash("sha256");
-  for (const id of hashIds) {
-    hash.update(id, "utf-8");
-  }
-  const h = hash.digest("hex").slice(0, 8);
-  const proposedName = baseName + "." + h;
-  return proposedName;
-}
 export {
   MarkdocError,
   PROPAGATED_ASSET_FLAG,
-  createNameHash,
   hasContentFlag,
   isValidUrl,
   parseFrontmatter,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/markdoc",
   "description": "Add support for Markdoc in your Astro site",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -19,32 +19,54 @@
   "bugs": "https://github.com/withastro/astro/issues",
   "homepage": "https://docs.astro.build/en/guides/integrations-guide/markdoc/",
   "exports": {
-    "./prism": "./dist/extensions/prism.js",
-    "./shiki": "./dist/extensions/shiki.js",
+    "./prism": {
+      "types": "./dist/extensions/prism.d.ts",
+      "default": "./dist/extensions/prism.js"
+    },
+    "./shiki": {
+      "types": "./dist/extensions/shiki.d.ts",
+      "default": "./dist/extensions/shiki.js"
+    },
+    "./config": {
+      "types": "./dist/config.d.ts",
+      "default": "./dist/config.js"
+    },
     ".": "./dist/index.js",
     "./components": "./components/index.ts",
     "./runtime": "./dist/runtime.js",
-    "./config": "./dist/config.js",
     "./experimental-assets-config": "./dist/experimental-assets-config.js",
     "./package.json": "./package.json"
   },
+  "typesVersions": {
+    "*": {
+      "config": [
+        "./dist/config.d.ts"
+      ],
+      "prism": [
+        "./dist/extensions/prism.d.ts"
+      ],
+      "shiki": [
+        "./dist/extensions/shiki.d.ts"
+      ]
+    }
+  },
   "files": [
     "components",
     "dist",
     "template"
   ],
   "dependencies": {
-    "shiki": "^0.14.1",
     "@astrojs/prism": "^2.1.2",
     "@markdoc/markdoc": "^0.3.0",
     "esbuild": "^0.17.12",
     "github-slugger": "^2.0.0",
     "gray-matter": "^4.0.3",
     "kleur": "^4.1.5",
+    "shiki": "^0.14.1",
     "zod": "^3.17.3"
   },
   "peerDependencies": {
-    "astro": "^2.5.7"
+    "astro": "^2.6.3"
   },
   "devDependencies": {
     "@astrojs/markdown-remark": "^2.2.1",
@@ -52,12 +74,12 @@
     "@types/html-escaper": "^3.0.0",
     "@types/mocha": "^9.1.1",
     "chai": "^4.3.6",
-    "devalue": "^4.2.0",
+    "devalue": "^4.3.2",
     "linkedom": "^0.14.12",
     "mocha": "^9.2.2",
     "rollup": "^3.20.1",
     "vite": "^4.3.1",
-    "astro": "2.5.7",
+    "astro": "2.6.3",
     "astro-scripts": "0.0.14"
   },
   "engines": {