@analogjs/content 3.0.0-alpha.3 → 3.0.0-alpha.30

package/types/mdc/src/lib/mdc-renderer.directive.d.ts

@@ -0,0 +1,33 @@
+import { InputSignal } from '@angular/core';
+import * as i0 from "@angular/core";
+type ComarkNode = string | [string | null, Record<string, unknown>, ...ComarkNode[]];
+/**
+ * Directive that renders MDC (Markdown Components) AST nodes as Angular components.
+ *
+ * Walks the ComarkTree AST from md4x's `parseAST()`, matches component nodes
+ * to the registered MDC_COMPONENTS map, and instantiates them via
+ * `ViewContainerRef.createComponent()` with MDC attributes bound as inputs.
+ *
+ * @experimental MDC component support is experimental and may change in future releases.
+ *
+ * @example
+ * ```html
+ * <div [mdcAst]="parsedAst"></div>
+ * ```
+ */
+export declare class MdcRendererDirective {
+    readonly ast: InputSignal<{
+        nodes: ComarkNode[];
+    } | null>;
+    private readonly viewContainer;
+    private readonly renderer;
+    private readonly el;
+    private readonly components;
+    private renderId;
+    constructor();
+    private renderNodes;
+    private renderNode;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MdcRendererDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MdcRendererDirective, "[mdcAst]", never, { "ast": { "alias": "mdcAst"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+export {};

package/types/prism-highlighter/src/lib/prism-highlighter.d.ts

@@ -1,4 +1,4 @@
-import { MarkedContentHighlighter } from '@analogjs/content';
+import { MarkedContentHighlighter } from '../../../src/lib/marked-content-highlighter';
 import * as i0 from "@angular/core";
 export declare class PrismHighlighter extends MarkedContentHighlighter {
     augmentCodeBlock(code: string, lang: string): string;

package/types/resources/src/content-file-resource.d.ts

@@ -1,14 +1,39 @@
-import { ResourceRef, Signal } from '@angular/core';
-import { ContentFile } from '@analogjs/content';
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+import { Signal, type ResourceRef } from '@angular/core';
+import type { ContentFile } from '../../src/lib/content-file';
+export interface ContentFileResourceResult<Attributes extends Record<string, any> = Record<string, any>> extends ContentFile<Attributes | Record<string, never>> {
+    toc: Array<{
+        id: string;
+        level: number;
+        text: string;
+    }>;
+}
 type ContentFileParams = Signal<string | {
     customFilename: string;
+}> | Signal<string> | Signal<{
+    customFilename: string;
 }>;
 /**
- * Resource for requesting an individual content file
+ * Resource for requesting an individual content file.
+ *
+ * @example
+ * ```typescript
+ * // Without schema (existing behavior)
+ * const post = contentFileResource<BlogAttributes>();
  *
- * @param params
- * @param fallback
- * @returns
+ * // With schema validation
+ * import * as v from 'valibot';
+ * const BlogSchema = v.object({
+ *   title: v.string(),
+ *   date: v.pipe(v.string(), v.isoDate()),
+ * });
+ * const post = contentFileResource({ schema: BlogSchema });
+ * ```
  */
-export declare function contentFileResource<Attributes extends Record<string, any> = Record<string, any>>(params?: ContentFileParams, fallback?: string): ResourceRef<ContentFile<Attributes | Record<string, never>> | undefined>;
+export declare function contentFileResource<Attributes extends Record<string, any> = Record<string, any>>(params?: ContentFileParams, fallback?: string): ResourceRef<ContentFileResourceResult<Attributes> | undefined>;
+export declare function contentFileResource<TSchema extends StandardSchemaV1>(options: {
+    params?: ContentFileParams;
+    fallback?: string;
+    schema: TSchema;
+}): ResourceRef<ContentFileResourceResult<StandardSchemaV1.InferOutput<TSchema> & Record<string, any>> | undefined>;
 export {};

package/types/resources/src/content-files-resource.d.ts

@@ -1,3 +1,4 @@
 import { ResourceRef } from '@angular/core';
-import { ContentFile, InjectContentFilesFilterFunction } from '@analogjs/content';
+import type { ContentFile } from '../../src/lib/content-file';
+import type { InjectContentFilesFilterFunction } from '../../src/lib/inject-content-files';
 export declare function contentFilesResource<Attributes extends Record<string, any>>(filterFn?: InjectContentFilesFilterFunction<Attributes> | undefined): ResourceRef<ContentFile<Attributes>[] | undefined>;

package/types/src/index.d.ts

@@ -1,13 +1,15 @@
 export { AnchorNavigationDirective } from './lib/anchor-navigation.directive';
 export { injectContent } from './lib/content';
-export { ContentFile } from './lib/content-file';
+export type { ContentFile } from './lib/content-file';
 export { ContentRenderer, NoopContentRenderer } from './lib/content-renderer';
-export { injectContentFiles, InjectContentFilesFilterFunction, } from './lib/inject-content-files';
+export type { RenderedContent, TableOfContentItem, } from './lib/content-renderer';
+export { injectContentFiles } from './lib/inject-content-files';
+export type { InjectContentFilesFilterFunction } from './lib/inject-content-files';
 export { MarkdownContentRendererService } from './lib/markdown-content-renderer.service';
 export { provideContent, withMarkdownRenderer, MERMAID_IMPORT_TOKEN, } from './lib/provide-content';
 export { default as MarkdownRouteComponent } from './lib/markdown-route.component';
 export { default as MarkdownComponent } from './lib/markdown.component';
-export { parseRawContentFile } from './lib/parse-raw-content-file';
+export { parseRawContentFile, parseRawContentFileAsync, FrontmatterValidationError, } from './lib/parse-raw-content-file';
 export { MarkedSetupService } from './lib/marked-setup.service';
 export { MarkedContentHighlighter, withHighlighter, } from './lib/marked-content-highlighter';
 export { injectContentFilesMap } from './lib/inject-content-files';

package/types/src/lib/devtools/content-devtools-plugin.d.ts

@@ -0,0 +1,23 @@
+import type { Plugin } from 'vite';
+/**
+ * Vite plugin that injects the Analog Content DevTools panel in dev mode.
+ *
+ * Shows render time, frontmatter data, TOC, and content stats in a floating
+ * panel. Dev-only — completely stripped from production builds.
+ *
+ * @experimental Content DevTools is experimental and may change in future releases.
+ *
+ * @example
+ * ```typescript
+ * // vite.config.ts
+ * import { contentDevToolsPlugin } from '@analogjs/content/devtools';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     analog({ ... }),
+ *     contentDevToolsPlugin(),
+ *   ],
+ * });
+ * ```
+ */
+export declare function contentDevToolsPlugin(): Plugin;

package/types/src/lib/devtools/content-devtools-renderer.d.ts

@@ -0,0 +1,23 @@
+import { InjectionToken } from '@angular/core';
+import { ContentRenderer, RenderedContent, TableOfContentItem } from '../content-renderer';
+import * as i0 from "@angular/core";
+/**
+ * Token for the wrapped renderer that DevTools delegates to.
+ * @internal
+ */
+export declare const DEVTOOLS_INNER_RENDERER: InjectionToken<ContentRenderer>;
+/**
+ * Wraps an existing ContentRenderer to collect timing and metadata for the
+ * Content DevTools panel. Dispatches a custom event on the window after
+ * each render so the devtools client can update.
+ *
+ * @experimental Content DevTools is experimental and may change in future releases.
+ */
+export declare class DevToolsContentRenderer extends ContentRenderer {
+    private readonly inner;
+    render(content: string): Promise<RenderedContent>;
+    getContentHeadings(content: string): TableOfContentItem[];
+    enhance(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DevToolsContentRenderer, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DevToolsContentRenderer>;
+}

package/types/src/lib/devtools/index.d.ts

@@ -0,0 +1,23 @@
+import { Provider, Type } from '@angular/core';
+import { ContentRenderer } from '../content-renderer';
+export { contentDevToolsPlugin } from './content-devtools-plugin';
+export { DevToolsContentRenderer, DEVTOOLS_INNER_RENDERER, } from './content-devtools-renderer';
+/**
+ * Wraps the given ContentRenderer with DevTools instrumentation.
+ *
+ * The supplied renderer class is provided under DEVTOOLS_INNER_RENDERER and
+ * DevToolsContentRenderer becomes the new ContentRenderer, delegating
+ * all calls and collecting timing data.
+ *
+ * @param innerRenderer The renderer class to wrap with devtools instrumentation.
+ *
+ * @experimental Content DevTools is experimental and may change in future releases.
+ *
+ * @example
+ * ```typescript
+ * provideContent(
+ *   withContentDevTools(NoopContentRenderer),
+ * );
+ * ```
+ */
+export declare function withContentDevTools(innerRenderer: Type<ContentRenderer>): Provider;

package/types/src/lib/parse-raw-content-file.d.ts

@@ -1,4 +1,18 @@
-export declare function parseRawContentFile<Attributes extends Record<string, any>>(rawContentFile: string): {
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+export declare class FrontmatterValidationError extends Error {
+    readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+    readonly filename?: string | undefined;
+    constructor(issues: ReadonlyArray<StandardSchemaV1.Issue>, filename?: string | undefined);
+}
+export declare function parseRawContentFile<Attributes extends Record<string, any> = Record<string, any>>(rawContentFile: string): {
     content: string;
     attributes: Attributes;
 };
+export declare function parseRawContentFile<TSchema extends StandardSchemaV1>(rawContentFile: string, schema: TSchema, filename?: string): {
+    content: string;
+    attributes: StandardSchemaV1.InferOutput<TSchema>;
+};
+export declare function parseRawContentFileAsync<TSchema extends StandardSchemaV1>(rawContentFile: string, schema: TSchema, filename?: string): Promise<{
+    content: string;
+    attributes: StandardSchemaV1.InferOutput<TSchema>;
+}>;

package/plugin/README.md

@@ -1,11 +0,0 @@
-# content-plugin
-
-This library was generated with [Nx](https://nx.dev).
-
-## Building
-
-Run `nx build content-plugin` to build the library.
-
-## Running unit tests
-
-Run `nx test content-plugin` to execute the unit tests via [Vitest](https://vitest.dev).

package/plugin/src/migrations/update-markdown-renderer-feature/compat.d.ts

@@ -1,3 +0,0 @@
-import { convertNxGenerator } from '@nx/devkit';
-declare const _default: ReturnType<typeof convertNxGenerator>;
-export default _default;

package/plugin/src/migrations/update-markdown-renderer-feature/compat.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const devkit_1 = require("@nx/devkit");
-const update_markdown_renderer_feature_1 = tslib_1.__importDefault(require("./update-markdown-renderer-feature"));
-const _default = (0, devkit_1.convertNxGenerator)(update_markdown_renderer_feature_1.default);
-exports.default = _default;
-//# sourceMappingURL=compat.js.map

package/plugin/src/migrations/update-markdown-renderer-feature/update-markdown-renderer-feature.d.ts

@@ -1,2 +0,0 @@
-import { Tree } from '@nx/devkit';
-export default function update(host: Tree): Promise<(() => void) | undefined>;

package/plugin/src/migrations/update-markdown-renderer-feature/update-markdown-renderer-feature.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = update;
-const devkit_1 = require("@nx/devkit");
-const ts_morph_1 = require("ts-morph");
-async function update(host) {
-    let project;
-    (0, devkit_1.visitNotIgnoredFiles)(host, '/', (file) => {
-        if (file.endsWith('.ts')) {
-            const content = host.read(file, 'utf-8');
-            if (content &&
-                content.includes('withMarkdownRenderer') &&
-                !content.includes('withPrismHighlighter') &&
-                !content.includes('withShikiHighlighter')) {
-                if (!project) {
-                    project = new ts_morph_1.Project({
-                        useInMemoryFileSystem: true,
-                        skipAddingFilesFromTsConfig: true,
-                    });
-                }
-                const sourceFile = project.createSourceFile(file, content);
-                const provideContentNode = sourceFile.getFirstDescendant((node) => ts_morph_1.Node.isCallExpression(node) &&
-                    node.getText().includes('provideContent') &&
-                    node.getText().includes('withMarkdownRenderer'));
-                if (provideContentNode) {
-                    sourceFile.addImportDeclaration({
-                        moduleSpecifier: '@analogjs/content/prism-highlighter',
-                        namedImports: ['withPrismHighlighter'],
-                    });
-                    provideContentNode.addArgument('withPrismHighlighter()');
-                }
-                host.write(file, sourceFile.getFullText());
-            }
-        }
-    });
-    // NOTE: we only add the dependency if the project is an Angular project
-    //  Nx projects can add the dependency from migrations.json
-    let dependencyAdded = false;
-    if (host.exists('/angular.json')) {
-        (0, devkit_1.addDependenciesToPackageJson)(host, { 'marked-mangle': '^1.1.7' }, {});
-        dependencyAdded = true;
-    }
-    await (0, devkit_1.formatFiles)(host);
-    if (dependencyAdded) {
-        return () => (0, devkit_1.installPackagesTask)(host);
-    }
-}
-//# sourceMappingURL=update-markdown-renderer-feature.js.map