@mzebley/mark-down 1.2.1 → 1.2.3

package/README.md

@@ -1,5 +1,6 @@
 # mark↓ Core Runtime
-*(published as `@mzebley/mark-down`)*
+
+_(published as `@mzebley/mark-down`)_
 
 This package provides the framework-agnostic `SnippetClient` and supporting types used to fetch, cache, and render Markdown snippets at runtime. For a monorepo overview visit the [root README](../../README.md).
 
@@ -54,9 +55,12 @@ The client lazily loads the manifest when first needed, then fetches Markdown fi
 - **`cache`** (`boolean`, default `true`) – enable or disable per-snippet and manifest memoisation.
 - **`verbose`** (`boolean`) – log helpful warnings (for example, slug mismatches) during development.
 - **`render`** (`(markdown: string) => string | Promise<string>`) – override the default `marked` renderer when you need custom HTML output.
+- **`sanitize`** (`{ policy?: "default" | "strict" | "permissive"; config?: SanitizeHtmlOptions }`) – optionally sanitize rendered HTML before it is returned.
 
 All options are optional except `manifest`. Results are rendered with `marked` by default; override at the application level if you need a different Markdown pipeline.
 
+`sanitize` is opt-in and uses [`sanitize-html`](https://github.com/apostrophecms/sanitize-html) under the hood. Use the `policy` presets for common Markdown output or override the `config` to tweak allowed tags/attributes. The React and Angular adapters already sanitize before rendering; enabling `sanitize` with those adapters is usually redundant.
+
 ## Working with snippets
 
 Commonly used APIs:
@@ -80,12 +84,13 @@ import { SnippetClient } from "@mzebley/mark-down";
 
 const client = new SnippetClient({
   manifest: () => import("./snippets-index.json"),
-  fetch: (url) => fetch(url).then((response) => {
-    if (!response.ok) {
-      throw new Error(`Request failed with status ${response.status}`);
-    }
-    return response;
-  }),
+  fetch: (url) =>
+    fetch(url).then((response) => {
+      if (!response.ok) {
+        throw new Error(`Request failed with status ${response.status}`);
+      }
+      return response;
+    }),
 });
 ```
 
@@ -145,11 +150,7 @@ Host the UMD file yourself or load it from a CDN—no build tooling required.
 Write plain Markdown directly in your HTML. The helper finds `[data-markdown]` blocks by default.
 
 ```html
-<div data-markdown>
-# Hello
-
-This is inline markdown with no build step.
-</div>
+<div data-markdown># Hello This is inline markdown with no build step.</div>
 
 <script src="path/to/mark-down-inline.umd.js"></script>
 <script>
@@ -167,16 +168,8 @@ You can optionally prepend YAML front matter to provide metadata for each block.
 
 ```html
 <div data-markdown>
----
-slug: intro
-title: Introduction
-tags: [hero]
-variant: lead
----
-
-# Introduction
-
-This block has metadata.
+  --- slug: intro title: Introduction tags: [hero] variant: lead --- #
+  Introduction This block has metadata.
 </div>
 ```
 
@@ -196,6 +189,7 @@ enhanceInlineMarkdown({
   selector?: string; // defaults to "[data-markdown]"
   processFrontMatter?: boolean; // defaults to true
   applyMetaToDom?: boolean; // defaults to true
+  sanitize?: { policy?: "default" | "strict" | "permissive"; config?: SanitizeHtmlOptions };
 });
 ```
 

package/dist/angular/index.d.ts

@@ -0,0 +1,20 @@
+import { InjectionToken, Provider } from '@angular/core';
+import { Observable } from 'rxjs';
+import { f as SnippetClient, e as SnippetClientOptions, a as Snippet, S as SnippetMeta } from '../snippet-client-S6E_j24g.js';
+import '../sanitize-DI2uKnlG.js';
+import 'sanitize-html';
+
+declare const SNIPPET_CLIENT: InjectionToken<SnippetClient>;
+declare const SNIPPET_CLIENT_OPTIONS: InjectionToken<SnippetClientOptions>;
+declare function provideSnippetClient(options: SnippetClientOptions): Provider[];
+declare class MarkdownSnippetService {
+    private readonly client;
+    constructor(client: SnippetClient);
+    get(slug: string): Observable<Snippet>;
+    listAll(): Observable<SnippetMeta[]>;
+    listByGroup(group: string): Observable<SnippetMeta[]>;
+    listByType(type: string): Observable<SnippetMeta[]>;
+    html(slug: string): Observable<string>;
+}
+
+export { MarkdownSnippetService, SNIPPET_CLIENT, SNIPPET_CLIENT_OPTIONS, Snippet, SnippetClientOptions, SnippetMeta, provideSnippetClient };

package/dist/angular/index.js

@@ -0,0 +1,68 @@
+import {
+  SnippetClient
+} from "../chunk-X5L6GGFF.js";
+import "../chunk-ZEQXN4ZD.js";
+import "../chunk-WZCXKUXV.js";
+import {
+  __decorateClass,
+  __decorateParam
+} from "../chunk-BRKEJJFQ.js";
+
+// src/angular/index.ts
+import { Inject, Injectable, InjectionToken } from "@angular/core";
+import { from, map, shareReplay } from "rxjs";
+var SNIPPET_CLIENT = new InjectionToken(
+  "@mzebley/mark-down/SNIPPET_CLIENT"
+);
+var SNIPPET_CLIENT_OPTIONS = new InjectionToken(
+  "@mzebley/mark-down/SNIPPET_CLIENT_OPTIONS"
+);
+function provideSnippetClient(options) {
+  return [
+    { provide: SNIPPET_CLIENT_OPTIONS, useValue: options },
+    {
+      provide: SNIPPET_CLIENT,
+      useFactory: (opts) => new SnippetClient(opts),
+      deps: [SNIPPET_CLIENT_OPTIONS]
+    }
+  ];
+}
+var MarkdownSnippetService = class {
+  constructor(client) {
+    this.client = client;
+  }
+  get(slug) {
+    return from(this.client.get(slug)).pipe(
+      shareReplay({ bufferSize: 1, refCount: true })
+    );
+  }
+  listAll() {
+    return from(this.client.listAll()).pipe(
+      shareReplay({ bufferSize: 1, refCount: true })
+    );
+  }
+  listByGroup(group) {
+    return from(this.client.listByGroup(group)).pipe(
+      shareReplay({ bufferSize: 1, refCount: true })
+    );
+  }
+  listByType(type) {
+    return from(this.client.listByType(type)).pipe(
+      shareReplay({ bufferSize: 1, refCount: true })
+    );
+  }
+  html(slug) {
+    return this.get(slug).pipe(map((snippet) => snippet.html));
+  }
+};
+MarkdownSnippetService = __decorateClass([
+  Injectable({ providedIn: "root" }),
+  __decorateParam(0, Inject(SNIPPET_CLIENT))
+], MarkdownSnippetService);
+export {
+  MarkdownSnippetService,
+  SNIPPET_CLIENT,
+  SNIPPET_CLIENT_OPTIONS,
+  provideSnippetClient
+};
+//# sourceMappingURL=index.js.map

package/dist/angular/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/angular/index.ts"],"sourcesContent":["import { Inject, Injectable, InjectionToken, Provider } from \"@angular/core\";\nimport { from, map, Observable, shareReplay } from \"rxjs\";\nimport { SnippetClient } from \"../snippet-client\";\nimport type { Snippet, SnippetClientOptions, SnippetMeta } from \"../types\";\n\nexport const SNIPPET_CLIENT = new InjectionToken<SnippetClient>(\n  \"@mzebley/mark-down/SNIPPET_CLIENT\",\n);\nexport const SNIPPET_CLIENT_OPTIONS = new InjectionToken<SnippetClientOptions>(\n  \"@mzebley/mark-down/SNIPPET_CLIENT_OPTIONS\",\n);\n\nexport function provideSnippetClient(\n  options: SnippetClientOptions,\n): Provider[] {\n  return [\n    { provide: SNIPPET_CLIENT_OPTIONS, useValue: options },\n    {\n      provide: SNIPPET_CLIENT,\n      useFactory: (opts: SnippetClientOptions) => new SnippetClient(opts),\n      deps: [SNIPPET_CLIENT_OPTIONS],\n    },\n  ];\n}\n\n@Injectable({ providedIn: \"root\" })\nexport class MarkdownSnippetService {\n  constructor(@Inject(SNIPPET_CLIENT) private readonly client: SnippetClient) {}\n\n  get(slug: string): Observable<Snippet> {\n    return from(this.client.get(slug)).pipe(\n      shareReplay({ bufferSize: 1, refCount: true }),\n    );\n  }\n\n  listAll(): Observable<SnippetMeta[]> {\n    return from(this.client.listAll()).pipe(\n      shareReplay({ bufferSize: 1, refCount: true }),\n    );\n  }\n\n  listByGroup(group: string): Observable<SnippetMeta[]> {\n    return from(this.client.listByGroup(group)).pipe(\n      shareReplay({ bufferSize: 1, refCount: true }),\n    );\n  }\n\n  listByType(type: string): Observable<SnippetMeta[]> {\n    return from(this.client.listByType(type)).pipe(\n      shareReplay({ bufferSize: 1, refCount: true }),\n    );\n  }\n\n  html(slug: string): Observable<string> {\n    return this.get(slug).pipe(map((snippet) => snippet.html));\n  }\n}\n\nexport type { Snippet, SnippetClientOptions, SnippetMeta } from \"../types\";\n"],"mappings":";;;;;;;;;;;AAAA,SAAS,QAAQ,YAAY,sBAAgC;AAC7D,SAAS,MAAM,KAAiB,mBAAmB;AAI5C,IAAM,iBAAiB,IAAI;AAAA,EAChC;AACF;AACO,IAAM,yBAAyB,IAAI;AAAA,EACxC;AACF;AAEO,SAAS,qBACd,SACY;AACZ,SAAO;AAAA,IACL,EAAE,SAAS,wBAAwB,UAAU,QAAQ;AAAA,IACrD;AAAA,MACE,SAAS;AAAA,MACT,YAAY,CAAC,SAA+B,IAAI,cAAc,IAAI;AAAA,MAClE,MAAM,CAAC,sBAAsB;AAAA,IAC/B;AAAA,EACF;AACF;AAGO,IAAM,yBAAN,MAA6B;AAAA,EAClC,YAAqD,QAAuB;AAAvB;AAAA,EAAwB;AAAA,EAE7E,IAAI,MAAmC;AACrC,WAAO,KAAK,KAAK,OAAO,IAAI,IAAI,CAAC,EAAE;AAAA,MACjC,YAAY,EAAE,YAAY,GAAG,UAAU,KAAK,CAAC;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,UAAqC;AACnC,WAAO,KAAK,KAAK,OAAO,QAAQ,CAAC,EAAE;AAAA,MACjC,YAAY,EAAE,YAAY,GAAG,UAAU,KAAK,CAAC;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,YAAY,OAA0C;AACpD,WAAO,KAAK,KAAK,OAAO,YAAY,KAAK,CAAC,EAAE;AAAA,MAC1C,YAAY,EAAE,YAAY,GAAG,UAAU,KAAK,CAAC;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,WAAW,MAAyC;AAClD,WAAO,KAAK,KAAK,OAAO,WAAW,IAAI,CAAC,EAAE;AAAA,MACxC,YAAY,EAAE,YAAY,GAAG,UAAU,KAAK,CAAC;AAAA,IAC/C;AAAA,EACF;AAAA,EAEA,KAAK,MAAkC;AACrC,WAAO,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,YAAY,QAAQ,IAAI,CAAC;AAAA,EAC3D;AACF;AA9Ba,yBAAN;AAAA,EADN,WAAW,EAAE,YAAY,OAAO,CAAC;AAAA,EAEnB,0BAAO,cAAc;AAAA,GADvB;","names":[]}