@mzebley/mark-down 1.0.0

package/README.md

@@ -0,0 +1,118 @@
+# mark↓ Core Runtime
+*(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).
+
+## Table of contents
+
+1. [Installation](#installation)
+2. [Quick start](#quick-start)
+3. [Client options](#client-options)
+4. [Working with snippets](#working-with-snippets)
+5. [SSR and custom fetchers](#ssr-and-custom-fetchers)
+6. [Static sites / CDN usage](#static-sites--cdn-usage)
+7. [Testing & type safety](#testing--type-safety)
+8. [Related packages](#related-packages)
+9. [Roadmap](#roadmap)
+
+## Installation
+
+Install the runtime alongside your application code:
+
+```bash
+npm install @mzebley/mark-down
+```
+
+You will also need a manifest file generated by the CLI. See the [CLI documentation](../cli/README.md) for steps to build `snippets-index.json`.
+
+## Quick start
+
+```ts
+import { SnippetClient } from "@mzebley/mark-down";
+
+const client = new SnippetClient({
+  manifest: "/snippets-index.json",
+});
+
+const hero = await client.get("getting-started-welcome");
+const components = await client.listByType("component");
+
+console.log(hero?.title);
+```
+
+The client lazily loads the manifest when first needed, then fetches Markdown files on demand. Results are cached for the lifetime of the client instance.
+
+## Client options
+
+`SnippetClient` accepts a single configuration object:
+
+- **`manifest`** (`string | ManifestEntry[] | () => Promise<ManifestEntry[]>`) – where to load the manifest. Pass a URL (default), an in-memory array, or an async factory for advanced scenarios.
+- **`fetcher`** (`(input, init) => Promise<Response>`) – provide a custom fetch implementation. Useful for SSR environments or when using libraries like Axios.
+- **`markdownRenderer`** – a `(markdown: string) => string | Promise<string>` function. Override to swap the default `marked` renderer for something like `remark` or a bespoke pipeline.
+- **`resolveSnippetPath`** – map manifest entries to final URLs. Override when static assets live in a CDN or custom folder.
+
+All options are optional except `manifest`.
+
+## Working with snippets
+
+Commonly used APIs:
+
+- `client.get(slug)` – fetch a single snippet. Returns `Promise<Snippet | undefined>`.
+- `client.list(filterOrOptions)` – list snippets using predicates, offsets, and limits.
+- `client.listByType(type, options?)` – filter by `type`.
+- `client.listByGroup(group, options?)` – filter based on the folder-derived `group`.
+
+Metadata is preserved exactly as declared in front matter. Standard keys (`slug`, `title`, etc.) are copied onto `SnippetMeta` and everything else is available through the `extra` bag so you can access custom fields like `snippet.extra.ctaLabel`.
+
+## SSR and custom fetchers
+
+The runtime runs in browsers, Node.js, or edge runtimes. For server-side rendering:
+
+```ts
+import fetch from "node-fetch";
+import { SnippetClient } from "@mzebley/mark-down";
+
+const client = new SnippetClient({
+  manifest: () => import("./snippets-index.json"),
+  fetcher: (input, init) => fetch(input as string, init),
+});
+```
+
+You can also pre-seed snippets by passing an array to `manifest` to avoid network requests entirely.
+
+## Static sites / CDN usage
+
+Need to run mark↓ inside a plain `<script type="module">` context? Use the pre-bundled browser build published at `dist/browser.js`. It automatically polyfills the minimum `Buffer` APIs required by the runtime.
+
+```html
+<script type="module">
+  import { SnippetClient } from "https://cdn.jsdelivr.net/npm/@mzebley/mark-down/dist/browser.js";
+
+  const client = new SnippetClient({ manifest: "./snippets-index.json" });
+  const hero = await client.get("marketing-hero");
+  document.querySelector("#hero").innerHTML = hero.html;
+</script>
+```
+
+As long as you host `snippets-index.json` (generated by the CLI) alongside your static assets, this bundle works without any additional tooling or manual Buffer shims.
+
+## Testing & type safety
+
+- Use `SnippetMeta` and `Snippet` TypeScript types to describe props and state in your application.
+- Mock the client by providing a manifest array or by stubbing the `fetcher` function.
+- Run the workspace tests with `npm run test -- core` to exercise Vitest suites that cover caching, filtering, and Markdown conversion.
+
+## Related packages
+
+- [CLI](../cli/README.md) – generate and watch manifests during development.
+- [Angular adapter](../angular/README.md) – DI-aware provider, service, and component abstractions.
+- [React adapter](../react/README.md) – Hooks and components for React and Next.js applications.
+
+Looking for a step-by-step walkthrough? Start from the [Quick start guide in the root README](../../README.md#quick-start).
+
+## Roadmap
+
+- **Tag-aware helpers** – add `listByTag` and `listByExtra` filters for common metadata structures.
+- **Prefetch & hydration APIs** – expose utilities for bundling snippets with static builds or preloading ahead of navigation.
+- **Search integration** – optional fuzzy search index built from manifest data.
+- **Cache policies** – allow LRU or time-based eviction strategies to better suit long-lived sessions.

package/dist/browser.d.ts

@@ -0,0 +1,60 @@
+interface SnippetMeta {
+    slug: string;
+    title?: string;
+    order?: number | null;
+    type?: string;
+    tags?: string[];
+    draft?: boolean;
+    path: string;
+    group: string;
+    extra?: Record<string, unknown>;
+}
+interface Snippet extends SnippetMeta {
+    markdown: string;
+    html: string;
+}
+type SnippetFilter = (snippet: SnippetMeta) => boolean;
+interface ListOptions {
+    filter?: SnippetFilter;
+    limit?: number;
+    offset?: number;
+}
+type ManifestSource = string | SnippetMeta[] | (() => Promise<SnippetMeta[]> | SnippetMeta[]);
+interface SnippetClientOptions {
+    /** Where to load the manifest; defaults to `/snippets-index.json`. */
+    manifest: ManifestSource;
+    /** Custom fetch to use in Node environments. Falls back to global `fetch`. */
+    fetcher?: (input: string) => Promise<ResponseLike>;
+    /** Allows overriding markdown → HTML rendering. Defaults to `marked`. */
+    markdownRenderer?: (markdown: string) => Promise<string> | string;
+    /** Customize how snippet URLs are resolved; defaults to the manifest `path`. */
+    resolveSnippetPath?: (meta: SnippetMeta) => string;
+}
+interface ResponseLike {
+    ok: boolean;
+    status: number;
+    text(): Promise<string>;
+}
+
+declare class SnippetClient {
+    private readonly manifestSource;
+    private readonly fetcher;
+    private readonly markdownRenderer;
+    private readonly resolveSnippetPath;
+    private manifestPromise?;
+    private snippetCache;
+    constructor(options: SnippetClientOptions);
+    get(slug: string): Promise<Snippet | undefined>;
+    list(filter?: SnippetFilter | ListOptions, options?: ListOptions): Promise<SnippetMeta[]>;
+    listByType(type: string, options?: ListOptions): Promise<SnippetMeta[]>;
+    listByGroup(group: string, options?: ListOptions): Promise<SnippetMeta[]>;
+    private loadSnippet;
+    private fetchSnippet;
+    private loadManifest;
+    private resolveManifest;
+    private fetchText;
+}
+
+declare function normalizeSlug(input: string): string;
+
+export { type ListOptions, type ManifestSource, type ResponseLike, type Snippet, SnippetClient, type SnippetClientOptions, type SnippetFilter, type SnippetMeta, normalizeSlug };

package/dist/browser.js

@@ -0,0 +1,311 @@
+// src/snippet-client.ts
+import matter from "gray-matter";
+import { marked } from "marked";
+var OPTIONAL_FIELDS = [
+  "title",
+  "order",
+  "type",
+  "tags",
+  "draft"
+];
+var SnippetClient = class {
+  constructor(options) {
+    this.snippetCache = /* @__PURE__ */ new Map();
+    this.manifestSource = options.manifest;
+    this.fetcher = options.fetcher ?? defaultFetch;
+    this.markdownRenderer = options.markdownRenderer ?? marked.parse;
+    this.resolveSnippetPath = options.resolveSnippetPath ?? ((meta) => meta.path);
+  }
+  async get(slug) {
+    const manifest = await this.loadManifest();
+    const entry = manifest.find((snippet) => snippet.slug === slug);
+    if (!entry) {
+      return void 0;
+    }
+    return this.loadSnippet(entry);
+  }
+  async list(filter, options) {
+    const manifest = await this.loadManifest();
+    let predicate;
+    let finalOptions = {};
+    if (typeof filter === "function") {
+      predicate = filter;
+      finalOptions = options ?? {};
+    } else if (filter) {
+      finalOptions = filter;
+    } else if (options) {
+      finalOptions = options;
+    }
+    let items = manifest;
+    const filters = [];
+    if (predicate) {
+      filters.push(predicate);
+    }
+    if (finalOptions.filter) {
+      filters.push(finalOptions.filter);
+    }
+    if (filters.length) {
+      items = items.filter((entry) => filters.every((fn) => fn(entry)));
+    }
+    const offset = finalOptions.offset ?? 0;
+    const limit = finalOptions.limit;
+    if (offset > 0) {
+      items = items.slice(offset);
+    }
+    if (typeof limit === "number") {
+      items = items.slice(0, limit);
+    }
+    return [...items];
+  }
+  listByType(type, options) {
+    return this.list((entry) => entry.type === type, options);
+  }
+  listByGroup(group, options) {
+    return this.list((entry) => entry.group === group, options);
+  }
+  loadSnippet(meta) {
+    const cached = this.snippetCache.get(meta.slug);
+    if (cached) {
+      return cached;
+    }
+    const promise = this.fetchSnippet(meta);
+    this.snippetCache.set(meta.slug, promise);
+    return promise;
+  }
+  async fetchSnippet(meta) {
+    const snippetPath = this.resolveSnippetPath(meta);
+    const response = await this.fetcher(snippetPath);
+    if (!response.ok) {
+      throw new Error(`Failed to fetch snippet '${meta.slug}' (status ${response.status})`);
+    }
+    const rawContent = await response.text();
+    const parsed = matter(rawContent);
+    const frontMatter = sanitizeFrontMatter(parsed.data ?? {});
+    const mergedMeta = mergeFrontMatter(meta, frontMatter.meta);
+    const html = await this.markdownRenderer(parsed.content);
+    const baseExtra = mergedMeta.extra ?? {};
+    return {
+      ...mergedMeta,
+      extra: {
+        ...baseExtra,
+        ...frontMatter.extra
+      },
+      markdown: parsed.content,
+      html
+    };
+  }
+  loadManifest() {
+    if (!this.manifestPromise) {
+      this.manifestPromise = this.resolveManifest();
+    }
+    return this.manifestPromise;
+  }
+  async resolveManifest() {
+    if (Array.isArray(this.manifestSource)) {
+      return this.manifestSource;
+    }
+    if (typeof this.manifestSource === "function") {
+      const result = await this.manifestSource();
+      return Array.isArray(result) ? result : Promise.reject(new Error("Manifest function must return an array"));
+    }
+    const raw = await this.fetchText(this.manifestSource);
+    const manifest = JSON.parse(raw);
+    if (!Array.isArray(manifest)) {
+      throw new Error("Manifest must be an array");
+    }
+    return manifest;
+  }
+  async fetchText(path) {
+    const response = await this.fetcher(path);
+    if (!response.ok) {
+      throw new Error(`Failed to fetch manifest from ${path} (status ${response.status})`);
+    }
+    return response.text();
+  }
+};
+function sanitizeFrontMatter(data) {
+  const meta = {};
+  const extra = {};
+  for (const [key, value] of Object.entries(data)) {
+    if (OPTIONAL_FIELDS.includes(key)) {
+      if (key === "tags") {
+        meta.tags = normalizeTags(value);
+      } else {
+        meta[key] = value;
+      }
+    } else {
+      extra[key] = value;
+    }
+  }
+  return { meta, extra };
+}
+function normalizeTags(value) {
+  if (!value) {
+    return void 0;
+  }
+  if (Array.isArray(value)) {
+    return value.map((tag) => String(tag));
+  }
+  if (typeof value === "string") {
+    return value.split(",").map((tag) => tag.trim()).filter(Boolean);
+  }
+  return void 0;
+}
+function mergeFrontMatter(base, overrides) {
+  const merged = { ...base };
+  for (const field of OPTIONAL_FIELDS) {
+    const overrideValue = overrides[field];
+    if (overrideValue !== void 0 && merged[field] === void 0) {
+      merged[field] = overrideValue;
+    }
+  }
+  return merged;
+}
+async function defaultFetch(input) {
+  const runtimeFetch = globalThis.fetch;
+  if (!runtimeFetch) {
+    throw new Error("No global fetch implementation found. Provide a custom fetcher.");
+  }
+  return runtimeFetch(input);
+}
+
+// src/slug.ts
+var NON_ALPHANUMERIC = /[^a-z0-9]+/gi;
+var LEADING_TRAILING_DASH = /^-+|-+$/g;
+function normalizeSlug(input) {
+  const value = input?.trim();
+  if (!value) {
+    throw new Error("Cannot normalize an empty slug");
+  }
+  const normalized = value.toLowerCase().replace(NON_ALPHANUMERIC, "-").replace(/-{2,}/g, "-").replace(LEADING_TRAILING_DASH, "");
+  if (!normalized) {
+    throw new Error(`Slug '${input}' does not contain any alphanumeric characters`);
+  }
+  return normalized;
+}
+
+// src/browser.ts
+installBufferShim();
+function installBufferShim() {
+  const globalRef = globalThis;
+  if (typeof globalRef.Buffer !== "undefined") {
+    return;
+  }
+  const textEncoder = new TextEncoder();
+  const textDecoder = new TextDecoder();
+  class BrowserBuffer extends Uint8Array {
+    constructor(value) {
+      if (typeof value === "number") {
+        super(value);
+        return;
+      }
+      if (isArrayBufferLike(value)) {
+        super(new Uint8Array(value));
+        return;
+      }
+      if (ArrayBuffer.isView(value)) {
+        super(
+          new Uint8Array(value.buffer.slice(value.byteOffset, value.byteOffset + value.byteLength))
+        );
+        return;
+      }
+      super(Array.from(value));
+    }
+    toString(encoding = "utf-8") {
+      if (encoding !== "utf-8" && encoding !== "utf8") {
+        throw new Error(`Unsupported encoding '${encoding}' in browser Buffer shim`);
+      }
+      return textDecoder.decode(this);
+    }
+  }
+  const from = (value, encoding = "utf-8") => {
+    if (typeof value === "string") {
+      if (encoding !== "utf-8" && encoding !== "utf8") {
+        throw new Error(`Unsupported encoding '${encoding}' in browser Buffer shim`);
+      }
+      return new BrowserBuffer(textEncoder.encode(value));
+    }
+    if (isArrayBufferLike(value)) {
+      return new BrowserBuffer(new Uint8Array(value));
+    }
+    if (ArrayBuffer.isView(value)) {
+      return new BrowserBuffer(value);
+    }
+    if (typeof value.length === "number") {
+      return new BrowserBuffer(Array.from(value));
+    }
+    throw new TypeError("Unsupported input passed to Buffer.from in browser shim");
+  };
+  const alloc = (size, fill) => {
+    if (size < 0) {
+      throw new RangeError("Invalid Buffer size");
+    }
+    const buffer = new BrowserBuffer(size);
+    if (typeof fill === "number") {
+      buffer.fill(fill);
+    } else if (typeof fill === "string") {
+      if (!fill.length) {
+        buffer.fill(0);
+      } else {
+        const pattern = textEncoder.encode(fill);
+        for (let i = 0; i < buffer.length; i++) {
+          buffer[i] = pattern[i % pattern.length];
+        }
+      }
+    } else {
+      buffer.fill(0);
+    }
+    return buffer;
+  };
+  const concat = (buffers, totalLength) => {
+    const sanitized = Array.from(
+      buffers,
+      (buffer) => buffer instanceof BrowserBuffer ? buffer : new BrowserBuffer(buffer)
+    );
+    const length = totalLength ?? sanitized.reduce((acc, current) => acc + current.length, 0);
+    const result = new BrowserBuffer(length);
+    let offset = 0;
+    for (const buffer of sanitized) {
+      result.set(buffer, offset);
+      offset += buffer.length;
+    }
+    return result;
+  };
+  const byteLength = (value) => {
+    if (typeof value === "string") {
+      return textEncoder.encode(value).length;
+    }
+    if (value instanceof ArrayBuffer) {
+      return value.byteLength;
+    }
+    if (ArrayBuffer.isView(value)) {
+      return value.byteLength;
+    }
+    throw new TypeError("Unable to determine byte length for provided value");
+  };
+  Object.defineProperties(BrowserBuffer, {
+    from: { value: from },
+    isBuffer: { value: (candidate) => candidate instanceof BrowserBuffer },
+    alloc: { value: alloc },
+    concat: { value: concat },
+    byteLength: { value: byteLength }
+  });
+  BrowserBuffer.prototype.valueOf = function valueOf() {
+    return this;
+  };
+  globalRef.Buffer = BrowserBuffer;
+  if (typeof window !== "undefined" && typeof window.Buffer === "undefined") {
+    window.Buffer = globalRef.Buffer;
+  }
+}
+function isArrayBufferLike(value) {
+  if (value instanceof ArrayBuffer) {
+    return true;
+  }
+  return typeof SharedArrayBuffer !== "undefined" && value instanceof SharedArrayBuffer;
+}
+export {
+  SnippetClient,
+  normalizeSlug
+};
+//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/snippet-client.ts","../src/slug.ts","../src/browser.ts"],"sourcesContent":["import matter from \"gray-matter\";\nimport { marked } from \"marked\";\nimport type {\n  ListOptions,\n  ManifestSource,\n  ResponseLike,\n  Snippet,\n  SnippetClientOptions,\n  SnippetFilter,\n  SnippetMeta\n} from \"./types\";\n\nconst OPTIONAL_FIELDS: Array<keyof SnippetMeta> = [\n  \"title\",\n  \"order\",\n  \"type\",\n  \"tags\",\n  \"draft\"\n];\n\nexport class SnippetClient {\n  private readonly manifestSource: ManifestSource;\n  private readonly fetcher: (input: string) => Promise<ResponseLike>;\n  private readonly markdownRenderer: (markdown: string) => Promise<string> | string;\n  private readonly resolveSnippetPath: (meta: SnippetMeta) => string;\n  private manifestPromise?: Promise<SnippetMeta[]>;\n  private snippetCache = new Map<string, Promise<Snippet>>();\n\n  constructor(options: SnippetClientOptions) {\n    this.manifestSource = options.manifest;\n    this.fetcher = options.fetcher ?? defaultFetch;\n    this.markdownRenderer = options.markdownRenderer ?? marked.parse;\n    this.resolveSnippetPath = options.resolveSnippetPath ?? ((meta) => meta.path);\n  }\n\n  async get(slug: string): Promise<Snippet | undefined> {\n    const manifest = await this.loadManifest();\n    const entry = manifest.find((snippet) => snippet.slug === slug);\n    if (!entry) {\n      return undefined;\n    }\n\n    return this.loadSnippet(entry);\n  }\n\n  async list(filter?: SnippetFilter | ListOptions, options?: ListOptions): Promise<SnippetMeta[]> {\n    const manifest = await this.loadManifest();\n    let predicate: SnippetFilter | undefined;\n    let finalOptions: ListOptions = {};\n\n    if (typeof filter === \"function\") {\n      predicate = filter;\n      finalOptions = options ?? {};\n    } else if (filter) {\n      finalOptions = filter;\n    } else if (options) {\n      finalOptions = options;\n    }\n\n    let items = manifest;\n    const filters: SnippetFilter[] = [];\n    if (predicate) {\n      filters.push(predicate);\n    }\n    if (finalOptions.filter) {\n      filters.push(finalOptions.filter);\n    }\n    if (filters.length) {\n      items = items.filter((entry) => filters.every((fn) => fn(entry)));\n    }\n\n    const offset = finalOptions.offset ?? 0;\n    const limit = finalOptions.limit;\n    if (offset > 0) {\n      items = items.slice(offset);\n    }\n    if (typeof limit === \"number\") {\n      items = items.slice(0, limit);\n    }\n\n    return [...items];\n  }\n\n  listByType(type: string, options?: ListOptions): Promise<SnippetMeta[]> {\n    return this.list((entry) => entry.type === type, options);\n  }\n\n  listByGroup(group: string, options?: ListOptions): Promise<SnippetMeta[]> {\n    return this.list((entry) => entry.group === group, options);\n  }\n\n  private loadSnippet(meta: SnippetMeta): Promise<Snippet> {\n    const cached = this.snippetCache.get(meta.slug);\n    if (cached) {\n      return cached;\n    }\n\n    const promise = this.fetchSnippet(meta);\n    this.snippetCache.set(meta.slug, promise);\n    return promise;\n  }\n\n  private async fetchSnippet(meta: SnippetMeta): Promise<Snippet> {\n    const snippetPath = this.resolveSnippetPath(meta);\n    const response = await this.fetcher(snippetPath);\n    if (!response.ok) {\n      throw new Error(`Failed to fetch snippet '${meta.slug}' (status ${response.status})`);\n    }\n\n    const rawContent = await response.text();\n    const parsed = matter(rawContent);\n    const frontMatter = sanitizeFrontMatter(parsed.data ?? {});\n    const mergedMeta = mergeFrontMatter(meta, frontMatter.meta);\n\n    const html = await this.markdownRenderer(parsed.content);\n\n    const baseExtra = mergedMeta.extra ?? {};\n    return {\n      ...mergedMeta,\n      extra: {\n        ...baseExtra,\n        ...frontMatter.extra\n      },\n      markdown: parsed.content,\n      html\n    };\n  }\n\n  private loadManifest(): Promise<SnippetMeta[]> {\n    if (!this.manifestPromise) {\n      this.manifestPromise = this.resolveManifest();\n    }\n    return this.manifestPromise;\n  }\n\n  private async resolveManifest(): Promise<SnippetMeta[]> {\n    if (Array.isArray(this.manifestSource)) {\n      return this.manifestSource;\n    }\n\n    if (typeof this.manifestSource === \"function\") {\n      const result = await this.manifestSource();\n      return Array.isArray(result) ? result : Promise.reject(new Error(\"Manifest function must return an array\"));\n    }\n\n    const raw = await this.fetchText(this.manifestSource);\n    const manifest = JSON.parse(raw);\n    if (!Array.isArray(manifest)) {\n      throw new Error(\"Manifest must be an array\");\n    }\n    return manifest;\n  }\n\n  private async fetchText(path: string): Promise<string> {\n    const response = await this.fetcher(path);\n    if (!response.ok) {\n      throw new Error(`Failed to fetch manifest from ${path} (status ${response.status})`);\n    }\n    return response.text();\n  }\n}\n\nfunction sanitizeFrontMatter(data: Record<string, unknown>) {\n  const meta: Partial<SnippetMeta> = {};\n  const extra: Record<string, unknown> = {};\n\n  for (const [key, value] of Object.entries(data)) {\n    if (OPTIONAL_FIELDS.includes(key as keyof SnippetMeta)) {\n      if (key === \"tags\") {\n        meta.tags = normalizeTags(value);\n      } else {\n        (meta as Record<string, unknown>)[key] = value;\n      }\n    } else {\n      extra[key] = value;\n    }\n  }\n\n  return { meta, extra };\n}\n\nfunction normalizeTags(value: unknown): string[] | undefined {\n  if (!value) {\n    return undefined;\n  }\n  if (Array.isArray(value)) {\n    return value.map((tag) => String(tag));\n  }\n  if (typeof value === \"string\") {\n    return value\n      .split(\",\")\n      .map((tag) => tag.trim())\n      .filter(Boolean);\n  }\n  return undefined;\n}\n\nfunction mergeFrontMatter(base: SnippetMeta, overrides: Partial<SnippetMeta>): SnippetMeta {\n  const merged: SnippetMeta = { ...base };\n  for (const field of OPTIONAL_FIELDS) {\n    const overrideValue = overrides[field];\n    if (overrideValue !== undefined && merged[field] === undefined) {\n      merged[field] = overrideValue as never;\n    }\n  }\n  return merged;\n}\n\nasync function defaultFetch(input: string): Promise<ResponseLike> {\n  const runtimeFetch = (globalThis as typeof globalThis & { fetch?: typeof fetch }).fetch;\n  if (!runtimeFetch) {\n    throw new Error(\"No global fetch implementation found. Provide a custom fetcher.\");\n  }\n  return runtimeFetch(input);\n}\n","const NON_ALPHANUMERIC = /[^a-z0-9]+/gi;\nconst LEADING_TRAILING_DASH = /^-+|-+$/g;\n\nexport function normalizeSlug(input: string): string {\n  const value = input?.trim();\n  if (!value) {\n    throw new Error(\"Cannot normalize an empty slug\");\n  }\n\n  const normalized = value\n    .toLowerCase()\n    .replace(NON_ALPHANUMERIC, \"-\")\n    .replace(/-{2,}/g, \"-\")\n    .replace(LEADING_TRAILING_DASH, \"\");\n\n  if (!normalized) {\n    throw new Error(`Slug '${input}' does not contain any alphanumeric characters`);\n  }\n\n  return normalized;\n}\n","installBufferShim();\n\nexport * from \"./index\";\n\nfunction installBufferShim() {\n  const globalRef = globalThis as typeof globalThis & { Buffer?: BufferConstructor };\n\n  if (typeof globalRef.Buffer !== \"undefined\") {\n    return;\n  }\n\n  const textEncoder = new TextEncoder();\n  const textDecoder = new TextDecoder();\n\n  class BrowserBuffer extends Uint8Array {\n    constructor(value: number | ArrayBufferLike | ArrayBufferView | ArrayLike<number>) {\n      if (typeof value === \"number\") {\n        super(value);\n        return;\n      }\n\n      if (isArrayBufferLike(value)) {\n        super(new Uint8Array(value));\n        return;\n      }\n\n      if (ArrayBuffer.isView(value)) {\n        super(\n          new Uint8Array(value.buffer.slice(value.byteOffset, value.byteOffset + value.byteLength))\n        );\n        return;\n      }\n\n      super(Array.from(value));\n    }\n\n    override toString(encoding: BufferEncoding = \"utf-8\") {\n      if (encoding !== \"utf-8\" && encoding !== \"utf8\") {\n        throw new Error(`Unsupported encoding '${encoding}' in browser Buffer shim`);\n      }\n      return textDecoder.decode(this);\n    }\n  }\n\n  const from = (value: string | ArrayLike<number> | BufferSource, encoding: BufferEncoding = \"utf-8\") => {\n    if (typeof value === \"string\") {\n      if (encoding !== \"utf-8\" && encoding !== \"utf8\") {\n        throw new Error(`Unsupported encoding '${encoding}' in browser Buffer shim`);\n      }\n      return new BrowserBuffer(textEncoder.encode(value));\n    }\n\n    if (isArrayBufferLike(value)) {\n      return new BrowserBuffer(new Uint8Array(value));\n    }\n\n    if (ArrayBuffer.isView(value)) {\n      return new BrowserBuffer(value);\n    }\n\n    if (typeof (value as ArrayLike<number>).length === \"number\") {\n      return new BrowserBuffer(Array.from(value as ArrayLike<number>));\n    }\n\n    throw new TypeError(\"Unsupported input passed to Buffer.from in browser shim\");\n  };\n\n  const alloc = (size: number, fill?: number | string) => {\n    if (size < 0) {\n      throw new RangeError(\"Invalid Buffer size\");\n    }\n    const buffer = new BrowserBuffer(size);\n    if (typeof fill === \"number\") {\n      buffer.fill(fill);\n    } else if (typeof fill === \"string\") {\n      if (!fill.length) {\n        buffer.fill(0);\n      } else {\n        const pattern = textEncoder.encode(fill);\n        for (let i = 0; i < buffer.length; i++) {\n          buffer[i] = pattern[i % pattern.length];\n        }\n      }\n    } else {\n      buffer.fill(0);\n    }\n    return buffer;\n  };\n\n  const concat = (buffers: ArrayLike<Uint8Array>, totalLength?: number) => {\n    const sanitized = Array.from(buffers, (buffer) =>\n      buffer instanceof BrowserBuffer ? buffer : new BrowserBuffer(buffer)\n    );\n    const length = totalLength ?? sanitized.reduce((acc, current) => acc + current.length, 0);\n    const result = new BrowserBuffer(length);\n    let offset = 0;\n    for (const buffer of sanitized) {\n      result.set(buffer, offset);\n      offset += buffer.length;\n    }\n    return result;\n  };\n\n  const byteLength = (value: string | ArrayBuffer | ArrayBufferView) => {\n    if (typeof value === \"string\") {\n      return textEncoder.encode(value).length;\n    }\n    if (value instanceof ArrayBuffer) {\n      return value.byteLength;\n    }\n    if (ArrayBuffer.isView(value)) {\n      return value.byteLength;\n    }\n    throw new TypeError(\"Unable to determine byte length for provided value\");\n  };\n\n  Object.defineProperties(BrowserBuffer, {\n    from: { value: from },\n    isBuffer: { value: (candidate: unknown) => candidate instanceof BrowserBuffer },\n    alloc: { value: alloc },\n    concat: { value: concat },\n    byteLength: { value: byteLength }\n  });\n\n  BrowserBuffer.prototype.valueOf = function valueOf() {\n    return this;\n  };\n\n  globalRef.Buffer = BrowserBuffer as unknown as BufferConstructor;\n\n  if (typeof window !== \"undefined\" && typeof (window as typeof globalThis).Buffer === \"undefined\") {\n    (window as typeof globalThis & { Buffer?: BufferConstructor }).Buffer = globalRef.Buffer;\n  }\n}\n\nfunction isArrayBufferLike(value: unknown): value is ArrayBufferLike {\n  if (value instanceof ArrayBuffer) {\n    return true;\n  }\n  return typeof SharedArrayBuffer !== \"undefined\" && value instanceof SharedArrayBuffer;\n}\n"],"mappings":";AAAA,OAAO,YAAY;AACnB,SAAS,cAAc;AAWvB,IAAM,kBAA4C;AAAA,EAChD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,gBAAN,MAAoB;AAAA,EAQzB,YAAY,SAA+B;AAF3C,SAAQ,eAAe,oBAAI,IAA8B;AAGvD,SAAK,iBAAiB,QAAQ;AAC9B,SAAK,UAAU,QAAQ,WAAW;AAClC,SAAK,mBAAmB,QAAQ,oBAAoB,OAAO;AAC3D,SAAK,qBAAqB,QAAQ,uBAAuB,CAAC,SAAS,KAAK;AAAA,EAC1E;AAAA,EAEA,MAAM,IAAI,MAA4C;AACpD,UAAM,WAAW,MAAM,KAAK,aAAa;AACzC,UAAM,QAAQ,SAAS,KAAK,CAAC,YAAY,QAAQ,SAAS,IAAI;AAC9D,QAAI,CAAC,OAAO;AACV,aAAO;AAAA,IACT;AAEA,WAAO,KAAK,YAAY,KAAK;AAAA,EAC/B;AAAA,EAEA,MAAM,KAAK,QAAsC,SAA+C;AAC9F,UAAM,WAAW,MAAM,KAAK,aAAa;AACzC,QAAI;AACJ,QAAI,eAA4B,CAAC;AAEjC,QAAI,OAAO,WAAW,YAAY;AAChC,kBAAY;AACZ,qBAAe,WAAW,CAAC;AAAA,IAC7B,WAAW,QAAQ;AACjB,qBAAe;AAAA,IACjB,WAAW,SAAS;AAClB,qBAAe;AAAA,IACjB;AAEA,QAAI,QAAQ;AACZ,UAAM,UAA2B,CAAC;AAClC,QAAI,WAAW;AACb,cAAQ,KAAK,SAAS;AAAA,IACxB;AACA,QAAI,aAAa,QAAQ;AACvB,cAAQ,KAAK,aAAa,MAAM;AAAA,IAClC;AACA,QAAI,QAAQ,QAAQ;AAClB,cAAQ,MAAM,OAAO,CAAC,UAAU,QAAQ,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC;AAAA,IAClE;AAEA,UAAM,SAAS,aAAa,UAAU;AACtC,UAAM,QAAQ,aAAa;AAC3B,QAAI,SAAS,GAAG;AACd,cAAQ,MAAM,MAAM,MAAM;AAAA,IAC5B;AACA,QAAI,OAAO,UAAU,UAAU;AAC7B,cAAQ,MAAM,MAAM,GAAG,KAAK;AAAA,IAC9B;AAEA,WAAO,CAAC,GAAG,KAAK;AAAA,EAClB;AAAA,EAEA,WAAW,MAAc,SAA+C;AACtE,WAAO,KAAK,KAAK,CAAC,UAAU,MAAM,SAAS,MAAM,OAAO;AAAA,EAC1D;AAAA,EAEA,YAAY,OAAe,SAA+C;AACxE,WAAO,KAAK,KAAK,CAAC,UAAU,MAAM,UAAU,OAAO,OAAO;AAAA,EAC5D;AAAA,EAEQ,YAAY,MAAqC;AACvD,UAAM,SAAS,KAAK,aAAa,IAAI,KAAK,IAAI;AAC9C,QAAI,QAAQ;AACV,aAAO;AAAA,IACT;AAEA,UAAM,UAAU,KAAK,aAAa,IAAI;AACtC,SAAK,aAAa,IAAI,KAAK,MAAM,OAAO;AACxC,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,aAAa,MAAqC;AAC9D,UAAM,cAAc,KAAK,mBAAmB,IAAI;AAChD,UAAM,WAAW,MAAM,KAAK,QAAQ,WAAW;AAC/C,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI,MAAM,4BAA4B,KAAK,IAAI,aAAa,SAAS,MAAM,GAAG;AAAA,IACtF;AAEA,UAAM,aAAa,MAAM,SAAS,KAAK;AACvC,UAAM,SAAS,OAAO,UAAU;AAChC,UAAM,cAAc,oBAAoB,OAAO,QAAQ,CAAC,CAAC;AACzD,UAAM,aAAa,iBAAiB,MAAM,YAAY,IAAI;AAE1D,UAAM,OAAO,MAAM,KAAK,iBAAiB,OAAO,OAAO;AAEvD,UAAM,YAAY,WAAW,SAAS,CAAC;AACvC,WAAO;AAAA,MACL,GAAG;AAAA,MACH,OAAO;AAAA,QACL,GAAG;AAAA,QACH,GAAG,YAAY;AAAA,MACjB;AAAA,MACA,UAAU,OAAO;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,eAAuC;AAC7C,QAAI,CAAC,KAAK,iBAAiB;AACzB,WAAK,kBAAkB,KAAK,gBAAgB;AAAA,IAC9C;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAc,kBAA0C;AACtD,QAAI,MAAM,QAAQ,KAAK,cAAc,GAAG;AACtC,aAAO,KAAK;AAAA,IACd;AAEA,QAAI,OAAO,KAAK,mBAAmB,YAAY;AAC7C,YAAM,SAAS,MAAM,KAAK,eAAe;AACzC,aAAO,MAAM,QAAQ,MAAM,IAAI,SAAS,QAAQ,OAAO,IAAI,MAAM,wCAAwC,CAAC;AAAA,IAC5G;AAEA,UAAM,MAAM,MAAM,KAAK,UAAU,KAAK,cAAc;AACpD,UAAM,WAAW,KAAK,MAAM,GAAG;AAC/B,QAAI,CAAC,MAAM,QAAQ,QAAQ,GAAG;AAC5B,YAAM,IAAI,MAAM,2BAA2B;AAAA,IAC7C;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,UAAU,MAA+B;AACrD,UAAM,WAAW,MAAM,KAAK,QAAQ,IAAI;AACxC,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI,MAAM,iCAAiC,IAAI,YAAY,SAAS,MAAM,GAAG;AAAA,IACrF;AACA,WAAO,SAAS,KAAK;AAAA,EACvB;AACF;AAEA,SAAS,oBAAoB,MAA+B;AAC1D,QAAM,OAA6B,CAAC;AACpC,QAAM,QAAiC,CAAC;AAExC,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,IAAI,GAAG;AAC/C,QAAI,gBAAgB,SAAS,GAAwB,GAAG;AACtD,UAAI,QAAQ,QAAQ;AAClB,aAAK,OAAO,cAAc,KAAK;AAAA,MACjC,OAAO;AACL,QAAC,KAAiC,GAAG,IAAI;AAAA,MAC3C;AAAA,IACF,OAAO;AACL,YAAM,GAAG,IAAI;AAAA,IACf;AAAA,EACF;AAEA,SAAO,EAAE,MAAM,MAAM;AACvB;AAEA,SAAS,cAAc,OAAsC;AAC3D,MAAI,CAAC,OAAO;AACV,WAAO;AAAA,EACT;AACA,MAAI,MAAM,QAAQ,KAAK,GAAG;AACxB,WAAO,MAAM,IAAI,CAAC,QAAQ,OAAO,GAAG,CAAC;AAAA,EACvC;AACA,MAAI,OAAO,UAAU,UAAU;AAC7B,WAAO,MACJ,MAAM,GAAG,EACT,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,EACvB,OAAO,OAAO;AAAA,EACnB;AACA,SAAO;AACT;AAEA,SAAS,iBAAiB,MAAmB,WAA8C;AACzF,QAAM,SAAsB,EAAE,GAAG,KAAK;AACtC,aAAW,SAAS,iBAAiB;AACnC,UAAM,gBAAgB,UAAU,KAAK;AACrC,QAAI,kBAAkB,UAAa,OAAO,KAAK,MAAM,QAAW;AAC9D,aAAO,KAAK,IAAI;AAAA,IAClB;AAAA,EACF;AACA,SAAO;AACT;AAEA,eAAe,aAAa,OAAsC;AAChE,QAAM,eAAgB,WAA4D;AAClF,MAAI,CAAC,cAAc;AACjB,UAAM,IAAI,MAAM,iEAAiE;AAAA,EACnF;AACA,SAAO,aAAa,KAAK;AAC3B;;;ACtNA,IAAM,mBAAmB;AACzB,IAAM,wBAAwB;AAEvB,SAAS,cAAc,OAAuB;AACnD,QAAM,QAAQ,OAAO,KAAK;AAC1B,MAAI,CAAC,OAAO;AACV,UAAM,IAAI,MAAM,gCAAgC;AAAA,EAClD;AAEA,QAAM,aAAa,MAChB,YAAY,EACZ,QAAQ,kBAAkB,GAAG,EAC7B,QAAQ,UAAU,GAAG,EACrB,QAAQ,uBAAuB,EAAE;AAEpC,MAAI,CAAC,YAAY;AACf,UAAM,IAAI,MAAM,SAAS,KAAK,gDAAgD;AAAA,EAChF;AAEA,SAAO;AACT;;;ACpBA,kBAAkB;AAIlB,SAAS,oBAAoB;AAC3B,QAAM,YAAY;AAElB,MAAI,OAAO,UAAU,WAAW,aAAa;AAC3C;AAAA,EACF;AAEA,QAAM,cAAc,IAAI,YAAY;AACpC,QAAM,cAAc,IAAI,YAAY;AAAA,EAEpC,MAAM,sBAAsB,WAAW;AAAA,IACrC,YAAY,OAAuE;AACjF,UAAI,OAAO,UAAU,UAAU;AAC7B,cAAM,KAAK;AACX;AAAA,MACF;AAEA,UAAI,kBAAkB,KAAK,GAAG;AAC5B,cAAM,IAAI,WAAW,KAAK,CAAC;AAC3B;AAAA,MACF;AAEA,UAAI,YAAY,OAAO,KAAK,GAAG;AAC7B;AAAA,UACE,IAAI,WAAW,MAAM,OAAO,MAAM,MAAM,YAAY,MAAM,aAAa,MAAM,UAAU,CAAC;AAAA,QAC1F;AACA;AAAA,MACF;AAEA,YAAM,MAAM,KAAK,KAAK,CAAC;AAAA,IACzB;AAAA,IAES,SAAS,WAA2B,SAAS;AACpD,UAAI,aAAa,WAAW,aAAa,QAAQ;AAC/C,cAAM,IAAI,MAAM,yBAAyB,QAAQ,0BAA0B;AAAA,MAC7E;AACA,aAAO,YAAY,OAAO,IAAI;AAAA,IAChC;AAAA,EACF;AAEA,QAAM,OAAO,CAAC,OAAkD,WAA2B,YAAY;AACrG,QAAI,OAAO,UAAU,UAAU;AAC7B,UAAI,aAAa,WAAW,aAAa,QAAQ;AAC/C,cAAM,IAAI,MAAM,yBAAyB,QAAQ,0BAA0B;AAAA,MAC7E;AACA,aAAO,IAAI,cAAc,YAAY,OAAO,KAAK,CAAC;AAAA,IACpD;AAEA,QAAI,kBAAkB,KAAK,GAAG;AAC5B,aAAO,IAAI,cAAc,IAAI,WAAW,KAAK,CAAC;AAAA,IAChD;AAEA,QAAI,YAAY,OAAO,KAAK,GAAG;AAC7B,aAAO,IAAI,cAAc,KAAK;AAAA,IAChC;AAEA,QAAI,OAAQ,MAA4B,WAAW,UAAU;AAC3D,aAAO,IAAI,cAAc,MAAM,KAAK,KAA0B,CAAC;AAAA,IACjE;AAEA,UAAM,IAAI,UAAU,yDAAyD;AAAA,EAC/E;AAEA,QAAM,QAAQ,CAAC,MAAc,SAA2B;AACtD,QAAI,OAAO,GAAG;AACZ,YAAM,IAAI,WAAW,qBAAqB;AAAA,IAC5C;AACA,UAAM,SAAS,IAAI,cAAc,IAAI;AACrC,QAAI,OAAO,SAAS,UAAU;AAC5B,aAAO,KAAK,IAAI;AAAA,IAClB,WAAW,OAAO,SAAS,UAAU;AACnC,UAAI,CAAC,KAAK,QAAQ;AAChB,eAAO,KAAK,CAAC;AAAA,MACf,OAAO;AACL,cAAM,UAAU,YAAY,OAAO,IAAI;AACvC,iBAAS,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK;AACtC,iBAAO,CAAC,IAAI,QAAQ,IAAI,QAAQ,MAAM;AAAA,QACxC;AAAA,MACF;AAAA,IACF,OAAO;AACL,aAAO,KAAK,CAAC;AAAA,IACf;AACA,WAAO;AAAA,EACT;AAEA,QAAM,SAAS,CAAC,SAAgC,gBAAyB;AACvE,UAAM,YAAY,MAAM;AAAA,MAAK;AAAA,MAAS,CAAC,WACrC,kBAAkB,gBAAgB,SAAS,IAAI,cAAc,MAAM;AAAA,IACrE;AACA,UAAM,SAAS,eAAe,UAAU,OAAO,CAAC,KAAK,YAAY,MAAM,QAAQ,QAAQ,CAAC;AACxF,UAAM,SAAS,IAAI,cAAc,MAAM;AACvC,QAAI,SAAS;AACb,eAAW,UAAU,WAAW;AAC9B,aAAO,IAAI,QAAQ,MAAM;AACzB,gBAAU,OAAO;AAAA,IACnB;AACA,WAAO;AAAA,EACT;AAEA,QAAM,aAAa,CAAC,UAAkD;AACpE,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,YAAY,OAAO,KAAK,EAAE;AAAA,IACnC;AACA,QAAI,iBAAiB,aAAa;AAChC,aAAO,MAAM;AAAA,IACf;AACA,QAAI,YAAY,OAAO,KAAK,GAAG;AAC7B,aAAO,MAAM;AAAA,IACf;AACA,UAAM,IAAI,UAAU,oDAAoD;AAAA,EAC1E;AAEA,SAAO,iBAAiB,eAAe;AAAA,IACrC,MAAM,EAAE,OAAO,KAAK;AAAA,IACpB,UAAU,EAAE,OAAO,CAAC,cAAuB,qBAAqB,cAAc;AAAA,IAC9E,OAAO,EAAE,OAAO,MAAM;AAAA,IACtB,QAAQ,EAAE,OAAO,OAAO;AAAA,IACxB,YAAY,EAAE,OAAO,WAAW;AAAA,EAClC,CAAC;AAED,gBAAc,UAAU,UAAU,SAAS,UAAU;AACnD,WAAO;AAAA,EACT;AAEA,YAAU,SAAS;AAEnB,MAAI,OAAO,WAAW,eAAe,OAAQ,OAA6B,WAAW,aAAa;AAChG,IAAC,OAA8D,SAAS,UAAU;AAAA,EACpF;AACF;AAEA,SAAS,kBAAkB,OAA0C;AACnE,MAAI,iBAAiB,aAAa;AAChC,WAAO;AAAA,EACT;AACA,SAAO,OAAO,sBAAsB,eAAe,iBAAiB;AACtE;","names":[]}

package/dist/chunk-TQ5Y4RZJ.mjs

@@ -0,0 +1,19 @@
+// src/slug.ts
+var NON_ALPHANUMERIC = /[^a-z0-9]+/gi;
+var LEADING_TRAILING_DASH = /^-+|-+$/g;
+function normalizeSlug(input) {
+  const value = input?.trim();
+  if (!value) {
+    throw new Error("Cannot normalize an empty slug");
+  }
+  const normalized = value.toLowerCase().replace(NON_ALPHANUMERIC, "-").replace(/-{2,}/g, "-").replace(LEADING_TRAILING_DASH, "");
+  if (!normalized) {
+    throw new Error(`Slug '${input}' does not contain any alphanumeric characters`);
+  }
+  return normalized;
+}
+
+export {
+  normalizeSlug
+};
+//# sourceMappingURL=chunk-TQ5Y4RZJ.mjs.map

package/dist/chunk-TQ5Y4RZJ.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/slug.ts"],"sourcesContent":["const NON_ALPHANUMERIC = /[^a-z0-9]+/gi;\nconst LEADING_TRAILING_DASH = /^-+|-+$/g;\n\nexport function normalizeSlug(input: string): string {\n  const value = input?.trim();\n  if (!value) {\n    throw new Error(\"Cannot normalize an empty slug\");\n  }\n\n  const normalized = value\n    .toLowerCase()\n    .replace(NON_ALPHANUMERIC, \"-\")\n    .replace(/-{2,}/g, \"-\")\n    .replace(LEADING_TRAILING_DASH, \"\");\n\n  if (!normalized) {\n    throw new Error(`Slug '${input}' does not contain any alphanumeric characters`);\n  }\n\n  return normalized;\n}\n"],"mappings":";AAAA,IAAM,mBAAmB;AACzB,IAAM,wBAAwB;AAEvB,SAAS,cAAc,OAAuB;AACnD,QAAM,QAAQ,OAAO,KAAK;AAC1B,MAAI,CAAC,OAAO;AACV,UAAM,IAAI,MAAM,gCAAgC;AAAA,EAClD;AAEA,QAAM,aAAa,MAChB,YAAY,EACZ,QAAQ,kBAAkB,GAAG,EAC7B,QAAQ,UAAU,GAAG,EACrB,QAAQ,uBAAuB,EAAE;AAEpC,MAAI,CAAC,YAAY;AACf,UAAM,IAAI,MAAM,SAAS,KAAK,gDAAgD;AAAA,EAChF;AAEA,SAAO;AACT;","names":[]}