@astrojs/markdoc 0.0.0-data-collections-20230418125011 → 0.0.0-debug-missing-endpoint-20240209155111

package/LICENSE

@@ -20,7 +20,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-
 """
 This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/sveltejs/kit repository:
 
@@ -33,7 +32,6 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 """
 
-
 """
 This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/vitejs/vite repository:
 

package/README.md

@@ -2,325 +2,37 @@
 
 This **[Astro integration][astro-integration]** enables the usage of [Markdoc](https://markdoc.dev/) to create components, pages, and content collection entries.
 
-- <strong>[Why Markdoc?](#why-markdoc)</strong>
-- <strong>[Installation](#installation)</strong>
-- <strong>[Usage](#usage)</strong>
-- <strong>[Configuration](#configuration)</strong>
-- <strong>[Examples](#examples)</strong>
-- <strong>[Troubleshooting](#troubleshooting)</strong>
-- <strong>[Contributing](#contributing)</strong>
-- <strong>[Changelog](#changelog)</strong>
+## Documentation
 
-## Why Markdoc?
+Read the [`@astrojs/markdoc` docs][docs]
 
-Markdoc allows you to enhance your Markdown with [Astro components][astro-components]. If you have existing content authored in Markdoc, this integration allows you to bring those files to your Astro project using content collections.
+## Support
 
-## Installation
+- Get help in the [Astro Discord][discord]. Post questions in our `#support` forum, or visit our dedicated `#dev` channel to discuss current development and more!
 
-### Quick Install
+- Check our [Astro Integration Documentation][astro-integration] for more on integrations.
 
-The `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one.
-
-```sh
-# Using NPM
-npx astro add markdoc
-# Using Yarn
-yarn astro add markdoc
-# Using PNPM
-pnpm astro add markdoc
-```
-
-If you run into any issues, [feel free to report them to us on GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below.
-
-### Manual Install
-
-First, install the `@astrojs/markdoc` package using your package manager. If you're using npm or aren't sure, run this in the terminal:
-
-```sh
-npm install @astrojs/markdoc
-```
-
-Then, apply this integration to your `astro.config.*` file using the `integrations` property:
-
-__`astro.config.mjs`__
-
-```js ins={2} "markdoc()"
-import { defineConfig } from 'astro/config';
-import markdoc from '@astrojs/markdoc';
-
-export default defineConfig({
-  // ...
-  integrations: [markdoc()],
-});
-```
-
-
-### Editor Integration
-
-[VS Code](https://code.visualstudio.com/) supports Markdown by default. However, for Markdoc editor support, you may wish to add the following setting in your VSCode config. This ensures authoring Markdoc files provides a Markdown-like editor experience.
-
-```json title=".vscode/settings.json"
-"files.associations": {
-    "*.mdoc": "markdown"
-}
-```
-
-## Usage
-
-Markdoc files can only be used within content collections. Add entries to any content collection using the `.mdoc` extension:
-
-```sh
-src/content/docs/
-  why-markdoc.mdoc
-  quick-start.mdoc
-```
-
-Then, query your collection using the [Content Collection APIs](https://docs.astro.build/en/guides/content-collections/#querying-collections):
-
-```astro
----
-import { getEntryBySlug } from 'astro:content';
-
-const entry = await getEntryBySlug('docs', 'why-markdoc');
-const { Content } = await entry.render();
----
-
-<!--Access frontmatter properties with `data`-->
-<h1>{entry.data.title}</h1>
-<!--Render Markdoc contents with the Content component-->
-<Content />
-```
-
-📚 See the [Astro Content Collection docs][astro-content-collections] for more information.
-
-## Configuration
-
-`@astrojs/markdoc` offers configuration options to use all of Markdoc's features and connect UI components to your content.
-
-### Using components
-
-You can add Astro components to your Markdoc using both [Markdoc tags][markdoc-tags] and HTML element [nodes][markdoc-nodes].
-
-#### Render Markdoc tags as Astro components
-
-You may configure [Markdoc tags][markdoc-tags] that map to components. You can configure a new tag by creating a `markdoc.config.mjs|ts` file at the root of your project and configuring the `tag` attribute.
-
-This example renders an `Aside` component, and allows a `type` prop to be passed as a string:
-
-```js
-// markdoc.config.mjs
-import { defineMarkdocConfig } from '@astrojs/markdoc/config';
-import Aside from './src/components/Aside.astro';
-
-export default defineMarkdocConfig({
-  tags: {
-    aside: {
-      render: Aside,
-      attributes: {
-      // Markdoc requires type defs for each attribute.
-      // These should mirror the `Props` type of the component
-      // you are rendering. 
-      // See Markdoc's documentation on defining attributes
-      // https://markdoc.dev/docs/attributes#defining-attributes
-        type: { type: String },
-      }
-    },
-  },
-})
-```
-
-This component can now be used in your Markdoc files with the `{% aside %}` tag. Children will be passed to your component's default slot:
-
-```md
-# Welcome to Markdoc 👋
-
-{% aside type="tip" %}
-
-Use tags like this fancy "aside" to add some *flair* to your docs.
-
-{% /aside %}
-```
-
-#### Render Markdoc nodes / HTML elements as Astro components
-
-You may also want to map standard HTML elements like headings and paragraphs to components. For this, you can configure a custom [Markdoc node][markdoc-nodes]. This example overrides Markdoc's `heading` node to render a `Heading` component, passing the built-in `level` attribute as a prop:
-
-```js
-// markdoc.config.mjs
-import { defineMarkdocConfig } from '@astrojs/markdoc/config';
-import Heading from './src/components/Heading.astro';
-
-export default defineMarkdocConfig({
-  nodes: {
-    heading: {
-      render: Heading,
-      attributes: {
-        // Pass the attributes from Markdoc's default heading node
-        // as component props.
-        level: { type: String },
-      }
-    },
-  },
-})
-```
-
-Now, all Markdown headings will render with the `Heading.astro` component. This example uses a level 3 heading, automatically passing `level: 3` as the component prop:
-
-```md
-### I'm a level 3 heading!
-```
-
-📚 [Find all of Markdoc's built-in nodes and node attributes on their documentation.](https://markdoc.dev/docs/nodes#built-in-nodes)
-
-#### Use client-side UI components
-
-Today, the `components` prop does not support the `client:` directive for hydrating components. To embed client-side components, create a wrapper `.astro` file to import your component and apply a `client:` directive manually.
-
-This example wraps a `Aside.tsx` component with a `ClientAside.astro` wrapper:
-
-```astro
----
-// src/components/ClientAside.astro
-import Aside from './Aside';
----
-
-<Aside {...Astro.props} client:load />
-```
-
-This component can be passed to the `render` prop for any [tag][markdoc-tags] or [node][markdoc-nodes] in your config:
-
-```js
-// markdoc.config.mjs
-import { defineMarkdocConfig } from '@astrojs/markdoc/config';
-import Aside from './src/components/Aside.astro';
-
-export default defineMarkdocConfig({
-  tags: {
-    aside: {
-      render: Aside,
-      attributes: {
-        type: { type: String },
-      }
-    },
-  },
-})
-```
-
-### Access frontmatter and content collection information from your templates
-
-You can access content collection information from your Markdoc templates using the `$entry` variable. This includes the entry `slug`, `collection` name, and frontmatter `data` parsed by your content collection schema (if any). This example renders the `title` frontmatter property as a heading:
-
-```md
----
-title: Welcome to Markdoc 👋
----
-
-# {% $entry.data.title %}
-```
-
-The `$entry` object matches [the `CollectionEntry` type](https://docs.astro.build/en/reference/api-reference/#collection-entry-type), excluding the `.render()` property.
-
-### Markdoc config
-
-The `markdoc.config.mjs|ts` file accepts [all Markdoc configuration options](https://markdoc.dev/docs/config), including [tags](https://markdoc.dev/docs/tags) and [functions](https://markdoc.dev/docs/functions).
-
-You can pass these options from the default export in your `markdoc.config.mjs|ts` file:
-
-```js
-// markdoc.config.mjs
-import { defineMarkdocConfig } from '@astrojs/markdoc/config';
-
-export default defineMarkdocConfig({
-  functions: {
-    getCountryEmoji: {
-      transform(parameters) {
-        const [country] = Object.values(parameters);
-        const countryToEmojiMap = {
-          japan: '🇯🇵',
-          spain: '🇪🇸',
-          france: '🇫🇷',
-        }
-        return countryToEmojiMap[country] ?? '🏳'
-      },
-    },
-  },
-})
-```
-
-Now, you can call this function from any Markdoc content entry:
-
-```md
-¡Hola {% getCountryEmoji("spain") %}!
-```
-
-📚 [See the Markdoc documentation](https://markdoc.dev/docs/functions#creating-a-custom-function) for more on using variables or functions in your content.
-
-### Pass Markdoc variables
-
-You may need to pass [variables][markdoc-variables] to your content. This is useful when passing SSR parameters like A/B tests.
-
-Variables can be passed as props via the `Content` component:
-
-```astro
----
-import { getEntryBySlug } from 'astro:content';
-
-const entry = await getEntryBySlug('docs', 'why-markdoc');
-const { Content } = await entry.render();
----
-
-<!--Pass the `abTest` param as a variable-->
-<Content abTestGroup={Astro.params.abTestGroup} />
-```
-
-Now, `abTestGroup` is available as a variable in `docs/why-markdoc.mdoc`:
-
-```md
-{% if $abTestGroup === 'image-optimization-lover' %}
-
-Let me tell you about image optimization...
-
-{% /if %}
-```
-
-To make a variable global to all Markdoc files, you can use the `variables` attribute from your `markdoc.config.mjs|ts`:
-
-```js
-import { defineMarkdocConfig } from '@astrojs/markdoc/config';
-
-export default defineMarkdocConfig({
-  variables: {
-    environment: process.env.IS_PROD ? 'prod' : 'dev',
-  }
-})
-```
-
-## Examples
-
-*   The [Astro Markdoc starter template](https://github.com/withastro/astro/tree/latest/examples/with-markdoc) shows how to use Markdoc files in your Astro project.
-
-## Troubleshooting
-
-For help, check out the `#support` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help!
-
-You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
+- Submit bug reports and feature requests as [GitHub issues][issues].
 
 ## Contributing
 
-This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
+This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! These links will help you get started:
 
-## Changelog
+- [Contributor Manual][contributing]
+- [Code of Conduct][coc]
+- [Community Guide][community]
 
-See [CHANGELOG.md](https://github.com/withastro/astro/tree/main/packages/integrations/markdoc/CHANGELOG.md) for a history of changes to this integration.
+## License
 
-[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
-
-[astro-components]: https://docs.astro.build/en/core-concepts/astro-components/
-
-[astro-content-collections]: https://docs.astro.build/en/guides/content-collections/
+MIT
 
-[markdoc-tags]: https://markdoc.dev/docs/tags
+Copyright (c) 2023–present [Astro][astro]
 
-[markdoc-nodes]: https://markdoc.dev/docs/nodes
-
-[markdoc-variables]: https://markdoc.dev/docs/variables
+[astro]: https://astro.build/
+[docs]: https://docs.astro.build/en/guides/integrations-guide/markdoc/
+[contributing]: https://github.com/withastro/astro/blob/main/CONTRIBUTING.md
+[coc]: https://github.com/withastro/.github/blob/main/CODE_OF_CONDUCT.md
+[community]: https://github.com/withastro/.github/blob/main/COMMUNITY_GUIDE.md
+[discord]: https://astro.build/chat/
+[issues]: https://github.com/withastro/astro/issues
+[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/

package/components/Renderer.astro

@@ -1,4 +1,5 @@
 ---
+//! astro-head-inject
 import type { Config } from '@markdoc/markdoc';
 import Markdoc from '@markdoc/markdoc';
 import { ComponentNode, createTreeNode } from './TreeNode.js';
@@ -14,4 +15,10 @@ const ast = Markdoc.Ast.fromJSON(stringifiedAst);
 const content = Markdoc.transform(ast, config);
 ---
 
-<ComponentNode treeNode={createTreeNode(content)} />
+{
+	Array.isArray(content) ? (
+		content.map(async (c) => <ComponentNode treeNode={await createTreeNode(c)} />)
+	) : (
+		<ComponentNode treeNode={await createTreeNode(content)} />
+	)
+}

package/components/TreeNode.ts

@@ -1,17 +1,30 @@
-import type { AstroInstance } from 'astro';
-import { Fragment } from 'astro/jsx-runtime';
 import type { RenderableTreeNode } from '@markdoc/markdoc';
 import Markdoc from '@markdoc/markdoc';
-import { createComponent, renderComponent, render } from 'astro/runtime/server/index.js';
+import type { AstroInstance } from 'astro';
+import type { HTMLString } from 'astro/runtime/server/index.js';
+import {
+	createComponent,
+	createHeadAndContent,
+	isHTMLString,
+	render,
+	renderComponent,
+	renderScriptElement,
+	renderTemplate,
+	renderUniqueStylesheet,
+	unescapeHTML,
+} from 'astro/runtime/server/index.js';
 
 export type TreeNode =
 	| {
 			type: 'text';
-			content: string;
+			content: string | HTMLString;
 	  }
 	| {
 			type: 'component';
 			component: AstroInstance['default'];
+			collectedLinks?: string[];
+			collectedStyles?: string[];
+			collectedScripts?: string[];
 			props: Record<string, any>;
 			children: TreeNode[];
 	  }
@@ -25,6 +38,7 @@ export type TreeNode =
 export const ComponentNode = createComponent({
 	factory(result: any, { treeNode }: { treeNode: TreeNode }) {
 		if (treeNode.type === 'text') return render`${treeNode.content}`;
+
 		const slots = {
 			default: () =>
 				render`${treeNode.children.map((child) =>
@@ -32,37 +46,76 @@ export const ComponentNode = createComponent({
 				)}`,
 		};
 		if (treeNode.type === 'component') {
-			return renderComponent(
-				result,
-				treeNode.component.name,
-				treeNode.component,
-				treeNode.props,
-				slots
+			let styles = '',
+				links = '',
+				scripts = '';
+			if (Array.isArray(treeNode.collectedStyles)) {
+				styles = treeNode.collectedStyles
+					.map((style: any) =>
+						renderUniqueStylesheet(result, {
+							type: 'inline',
+							content: style,
+						})
+					)
+					.join('');
+			}
+			if (Array.isArray(treeNode.collectedLinks)) {
+				links = treeNode.collectedLinks
+					.map((link: any) => {
+						return renderUniqueStylesheet(result, {
+							type: 'external',
+							src: link[0] === '/' ? link : '/' + link,
+						});
+					})
+					.join('');
+			}
+			if (Array.isArray(treeNode.collectedScripts)) {
+				scripts = treeNode.collectedScripts
+					.map((script: any) => renderScriptElement(script))
+					.join('');
+			}
+
+			const head = unescapeHTML(styles + links + scripts);
+
+			let headAndContent = createHeadAndContent(
+				head,
+				renderTemplate`${renderComponent(
+					result,
+					treeNode.component.name,
+					treeNode.component,
+					treeNode.props,
+					slots
+				)}`
 			);
+
+			// Let the runtime know that this component is being used.
+			result._metadata.propagators.add({
+				init() {
+					return headAndContent;
+				},
+			});
+
+			return headAndContent;
 		}
 		return renderComponent(result, treeNode.tag, treeNode.tag, treeNode.attributes, slots);
 	},
-	propagation: 'none',
+	propagation: 'self',
 });
 
-export function createTreeNode(node: RenderableTreeNode | RenderableTreeNode[]): TreeNode {
-	if (typeof node === 'string' || typeof node === 'number') {
+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: node.map((child) => createTreeNode(child)),
-		};
 	} else if (node === null || typeof node !== 'object' || !Markdoc.Tag.isTag(node)) {
 		return { type: 'text', content: '' };
 	}
 
+	const children = await Promise.all(node.children.map((child) => createTreeNode(child)));
+
 	if (typeof node.name === 'function') {
 		const component = node.name;
 		const props = node.attributes;
-		const children = node.children.map((child) => createTreeNode(child));
 
 		return {
 			type: 'component',
@@ -70,12 +123,38 @@ export function createTreeNode(node: RenderableTreeNode | RenderableTreeNode[]):
 			props,
 			children,
 		};
+	} else if (isPropagatedAssetsModule(node.name)) {
+		const { collectedStyles, collectedLinks, collectedScripts } = node.name;
+		const component = (await node.name.getMod()).default;
+		const props = node.attributes;
+
+		return {
+			type: 'component',
+			component,
+			collectedStyles,
+			collectedLinks,
+			collectedScripts,
+			props,
+			children,
+		};
 	} else {
 		return {
 			type: 'element',
 			tag: node.name,
 			attributes: node.attributes,
-			children: node.children.map((child) => createTreeNode(child)),
+			children,
 		};
 	}
 }
+
+type PropagatedAssetsModule = {
+	__astroPropagation: true;
+	getMod: () => Promise<AstroInstance>;
+	collectedStyles: string[];
+	collectedLinks: string[];
+	collectedScripts: string[];
+};
+
+function isPropagatedAssetsModule(module: any): module is PropagatedAssetsModule {
+	return typeof module === 'object' && module != null && '__astroPropagation' in module;
+}

package/dist/config.d.ts

@@ -1,2 +1,57 @@
-import type { ConfigType as MarkdocConfig } from '@markdoc/markdoc';
-export declare function defineMarkdocConfig(config: MarkdocConfig): MarkdocConfig;
+import type { Config, ConfigType as MarkdocConfig, MaybePromise, NodeType, Schema } from '@markdoc/markdoc';
+import _Markdoc from '@markdoc/markdoc';
+import type { AstroInstance } from 'astro';
+import { componentConfigSymbol } from './utils.js';
+export type Render = ComponentConfig | AstroInstance['default'] | string;
+export type ComponentConfig = {
+    type: 'package' | 'local';
+    path: string;
+    namedExport?: string;
+    [componentConfigSymbol]: true;
+};
+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: 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: {
+                type: StringConstructor;
+                required: boolean;
+            };
+        };
+    };
+    error: {};
+    node: {};
+};
+export declare function defineMarkdocConfig(config: AstroMarkdocConfig): AstroMarkdocConfig;
+export declare function component(pathnameOrPkgName: string, namedExport?: string): ComponentConfig;

package/dist/config.js

@@ -1,6 +1,26 @@
+import { isRelativePath } from "@astrojs/internal-helpers/path";
+import _Markdoc from "@markdoc/markdoc";
+import { heading } from "./heading-ids.js";
+import { componentConfigSymbol } from "./utils.js";
+const Markdoc = _Markdoc;
+const nodes = { ...Markdoc.nodes, heading };
 function defineMarkdocConfig(config) {
   return config;
 }
+function component(pathnameOrPkgName, namedExport) {
+  return {
+    type: isNpmPackageName(pathnameOrPkgName) ? "package" : "local",
+    path: pathnameOrPkgName,
+    namedExport,
+    [componentConfigSymbol]: true
+  };
+}
+function isNpmPackageName(pathname) {
+  return !isRelativePath(pathname) && !pathname.startsWith("/");
+}
 export {
-  defineMarkdocConfig
+  Markdoc,
+  component,
+  defineMarkdocConfig,
+  nodes
 };

package/dist/content-entry-type.d.ts

@@ -0,0 +1,8 @@
+import type { AstroConfig, ContentEntryType } from 'astro';
+import type { MarkdocConfigResult } from './load-config.js';
+import type { MarkdocIntegrationOptions } from './options.js';
+export declare function getContentEntryType({ markdocConfigResult, astroConfig, options, }: {
+    astroConfig: AstroConfig;
+    markdocConfigResult?: MarkdocConfigResult;
+    options?: MarkdocIntegrationOptions;
+}): Promise<ContentEntryType>;