@mzebley/mark-down 1.2.0 → 1.2.2

package/dist/slug.d.ts

@@ -0,0 +1,3 @@
+declare function normalizeSlug(input: string): string;
+
+export { normalizeSlug };

package/dist/slug.js

@@ -0,0 +1,8 @@
+import {
+  normalizeSlug
+} from "./chunk-GWLMADTU.js";
+import "./chunk-BRKEJJFQ.js";
+export {
+  normalizeSlug
+};
+//# sourceMappingURL=slug.js.map

package/dist/slug.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/snippet-client-CiQX2Zcn.d.ts

@@ -0,0 +1,63 @@
+interface SnippetMeta {
+    slug: string;
+    title?: string;
+    type?: string;
+    order?: number;
+    tags?: string[];
+    path: string;
+    group?: string | null;
+    draft?: boolean;
+    extra?: Record<string, unknown>;
+}
+interface Snippet extends SnippetMeta {
+    html: string;
+    raw?: string;
+    markdown?: string;
+}
+interface SnippetSearchFilter {
+    type?: string;
+    group?: string;
+    tags?: string[];
+    tagsMode?: "any" | "all";
+}
+type ManifestSource = string | SnippetMeta[] | (() => Promise<SnippetMeta[]> | SnippetMeta[]);
+interface ResponseLike {
+    ok: boolean;
+    status: number;
+    text(): Promise<string>;
+}
+type SnippetFetcherResult = string | ResponseLike;
+type SnippetFetcher = (url: string) => Promise<SnippetFetcherResult>;
+interface SnippetClientOptions {
+    manifest: ManifestSource;
+    base?: string;
+    fetch?: SnippetFetcher;
+    frontMatter?: boolean;
+    cache?: boolean;
+    verbose?: boolean;
+    render?: (markdown: string) => string | Promise<string>;
+}
+
+declare class SnippetClient {
+    private readonly options;
+    private readonly manifestUrl?;
+    private readonly inferredBase?;
+    private manifestPromise?;
+    private readonly snippetCache;
+    constructor(options: SnippetClientOptions);
+    get(slug: string): Promise<Snippet>;
+    listAll(): Promise<SnippetMeta[]>;
+    listByGroup(group: string): Promise<SnippetMeta[]>;
+    listByType(type: string): Promise<SnippetMeta[]>;
+    search(filter: SnippetSearchFilter): Promise<SnippetMeta[]>;
+    getHtml(slug: string): Promise<string>;
+    invalidate(): void;
+    invalidateSlug(slug: string): void;
+    private loadManifest;
+    private resolveManifest;
+    private loadSnippet;
+    private fetchSnippet;
+    private resolveSnippetPath;
+}
+
+export { type ManifestSource as M, type ResponseLike as R, type SnippetMeta as S, type Snippet as a, type SnippetSearchFilter as b, type SnippetFetcherResult as c, type SnippetFetcher as d, type SnippetClientOptions as e, SnippetClient as f };

package/package.json

@@ -1,32 +1,38 @@
 {
   "name": "@mzebley/mark-down",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "mark↓ core runtime and shared utilities",
   "type": "module",
   "types": "dist/index.d.ts",
+  "files": ["dist"],
   "publishConfig": {
     "access": "public"
   },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
     },
     "./slug": {
       "types": "./dist/slug.d.ts",
-      "import": "./dist/slug.js"
+      "import": "./dist/slug.js",
+      "default": "./dist/slug.js"
     },
     "./browser": {
       "types": "./dist/browser.d.ts",
-      "import": "./dist/browser.js"
+      "import": "./dist/browser.js",
+      "default": "./dist/browser.js"
     },
     "./inline": {
       "types": "./dist/inline.d.ts",
-      "import": "./dist/inline.js"
+      "import": "./dist/inline.js",
+      "default": "./dist/inline.js"
     },
     "./angular": {
       "types": "./dist/angular/index.d.ts",
-      "import": "./dist/angular/index.js"
+      "import": "./dist/angular/index.js",
+      "default": "./dist/angular/index.js"
     }
   },
   "scripts": {

package/src/angular/index.ts

@@ -1,47 +0,0 @@
-import { Inject, Injectable, InjectionToken, Provider } from "@angular/core";
-import { from, map, Observable, shareReplay } from "rxjs";
-import { SnippetClient } from "../snippet-client";
-import type { Snippet, SnippetClientOptions, SnippetMeta } from "../types";
-
-export const SNIPPET_CLIENT = new InjectionToken<SnippetClient>("@mzebley/mark-down/SNIPPET_CLIENT");
-export const SNIPPET_CLIENT_OPTIONS = new InjectionToken<SnippetClientOptions>(
-  "@mzebley/mark-down/SNIPPET_CLIENT_OPTIONS"
-);
-
-export function provideSnippetClient(options: SnippetClientOptions): Provider[] {
-  return [
-    { provide: SNIPPET_CLIENT_OPTIONS, useValue: options },
-    {
-      provide: SNIPPET_CLIENT,
-      useFactory: (opts: SnippetClientOptions) => new SnippetClient(opts),
-      deps: [SNIPPET_CLIENT_OPTIONS]
-    }
-  ];
-}
-
-@Injectable({ providedIn: "root" })
-export class MarkdownSnippetService {
-  constructor(@Inject(SNIPPET_CLIENT) private readonly client: SnippetClient) {}
-
-  get(slug: string): Observable<Snippet> {
-    return from(this.client.get(slug)).pipe(shareReplay({ bufferSize: 1, refCount: true }));
-  }
-
-  listAll(): Observable<SnippetMeta[]> {
-    return from(this.client.listAll()).pipe(shareReplay({ bufferSize: 1, refCount: true }));
-  }
-
-  listByGroup(group: string): Observable<SnippetMeta[]> {
-    return from(this.client.listByGroup(group)).pipe(shareReplay({ bufferSize: 1, refCount: true }));
-  }
-
-  listByType(type: string): Observable<SnippetMeta[]> {
-    return from(this.client.listByType(type)).pipe(shareReplay({ bufferSize: 1, refCount: true }));
-  }
-
-  html(slug: string): Observable<string> {
-    return this.get(slug).pipe(map((snippet) => snippet.html));
-  }
-}
-
-export type { Snippet, SnippetClientOptions, SnippetMeta } from "../types";

package/src/browser.ts

@@ -1,141 +0,0 @@
-installBufferShim();
-
-export * from "./index";
-
-function installBufferShim() {
-  const globalRef = globalThis as typeof globalThis & { Buffer?: BufferConstructor };
-
-  if (typeof globalRef.Buffer !== "undefined") {
-    return;
-  }
-
-  const textEncoder = new TextEncoder();
-  const textDecoder = new TextDecoder();
-
-  class BrowserBuffer extends Uint8Array {
-    constructor(value: number | ArrayBufferLike | ArrayBufferView | ArrayLike<number>) {
-      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));
-    }
-
-    override toString(encoding: BufferEncoding = "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: string | ArrayLike<number> | BufferSource, encoding: BufferEncoding = "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 as ArrayLike<number>).length === "number") {
-      return new BrowserBuffer(Array.from(value as ArrayLike<number>));
-    }
-
-    throw new TypeError("Unsupported input passed to Buffer.from in browser shim");
-  };
-
-  const alloc = (size: number, fill?: number | string) => {
-    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: ArrayLike<Uint8Array>, totalLength?: number) => {
-    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: string | ArrayBuffer | ArrayBufferView) => {
-    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: unknown) => candidate instanceof BrowserBuffer },
-    alloc: { value: alloc },
-    concat: { value: concat },
-    byteLength: { value: byteLength }
-  });
-
-  BrowserBuffer.prototype.valueOf = function valueOf() {
-    return this;
-  };
-
-  globalRef.Buffer = BrowserBuffer as unknown as BufferConstructor;
-
-  if (typeof window !== "undefined" && typeof (window as typeof globalThis).Buffer === "undefined") {
-    (window as typeof globalThis & { Buffer?: BufferConstructor }).Buffer = globalRef.Buffer;
-  }
-}
-
-function isArrayBufferLike(value: unknown): value is ArrayBufferLike {
-  if (value instanceof ArrayBuffer) {
-    return true;
-  }
-  return typeof SharedArrayBuffer !== "undefined" && value instanceof SharedArrayBuffer;
-}

package/src/errors.ts

@@ -1,19 +0,0 @@
-export class SnippetNotFoundError extends Error {
-  readonly slug: string;
-
-  constructor(slug: string) {
-    super(`Snippet with slug '${slug}' was not found in the manifest.`);
-    this.name = "SnippetNotFoundError";
-    this.slug = slug;
-  }
-}
-
-export class ManifestLoadError extends Error {
-  readonly cause?: unknown;
-
-  constructor(message: string, cause?: unknown) {
-    super(message);
-    this.name = "ManifestLoadError";
-    this.cause = cause instanceof Error ? cause : cause ? new Error(String(cause)) : undefined;
-  }
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from "./types";
-export * from "./snippet-client";
-export { normalizeSlug } from "./slug";
-export { parseFrontMatter } from "./front-matter";
-export { renderMarkdown } from "./markdown";

package/src/markdown.ts

@@ -1,11 +0,0 @@
-import { marked } from "marked";
-
-export function renderMarkdown(markdown: string): string {
-  const html = marked.parse(markdown);
-
-  if (typeof html === "string") {
-    return html;
-  }
-
-  throw new Error("renderMarkdown unexpectedly returned a Promise");
-}

package/src/slug.ts

@@ -1,21 +0,0 @@
-const NON_ALPHANUMERIC = /[^a-z0-9]+/gi;
-const LEADING_TRAILING_DASH = /^-+|-+$/g;
-
-export function normalizeSlug(input: string): string {
-  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;
-}

package/src/types.ts

@@ -1,49 +0,0 @@
-export interface SnippetMeta {
-  slug: string;
-  title?: string;
-  type?: string;
-  order?: number;
-  tags?: string[];
-  path: string;
-  group?: string | null;
-  draft?: boolean;
-  extra?: Record<string, unknown>;
-}
-
-export interface Snippet extends SnippetMeta {
-  html: string;
-  raw?: string;
-  markdown?: string;
-}
-
-export interface SnippetSearchFilter {
-  type?: string;
-  group?: string;
-  tags?: string[];
-  tagsMode?: "any" | "all";
-}
-
-export type ManifestSource =
-  | string
-  | SnippetMeta[]
-  | (() => Promise<SnippetMeta[]> | SnippetMeta[]);
-
-export interface ResponseLike {
-  ok: boolean;
-  status: number;
-  text(): Promise<string>;
-}
-
-export type SnippetFetcherResult = string | ResponseLike;
-
-export type SnippetFetcher = (url: string) => Promise<SnippetFetcherResult>;
-
-export interface SnippetClientOptions {
-  manifest: ManifestSource;
-  base?: string;
-  fetch?: SnippetFetcher;
-  frontMatter?: boolean;
-  cache?: boolean;
-  verbose?: boolean;
-  render?: (markdown: string) => string | Promise<string>;
-}

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"]
-}

package/tsup.config.ts

@@ -1,59 +0,0 @@
-import { defineConfig } from "tsup";
-
-export default defineConfig([
-  {
-    entry: {
-      index: "src/index.ts",
-      slug: "src/slug.ts",
-      inline: "src/inline.ts",
-      "angular/index": "src/angular/index.ts"
-    },
-    format: ["esm"],
-    dts: true,
-    sourcemap: true,
-    clean: true,
-    target: "es2020",
-    external: ["@angular/core", "@angular/common", "@angular/router", "@angular/platform-browser", "rxjs"],
-    outExtension() {
-      return {
-        js: ".js"
-      };
-    }
-  },
-  {
-    entry: {
-      browser: "src/browser.ts"
-    },
-    format: ["esm"],
-    dts: true,
-    sourcemap: true,
-    clean: false,
-    target: "es2020",
-    platform: "browser",
-    splitting: false,
-    outExtension() {
-      return {
-        js: ".js"
-      };
-    }
-  },
-  {
-    entry: {
-      "mark-down-inline": "src/inline.ts"
-    },
-    format: ["iife"],
-    globalName: "markDownInline",
-    dts: false,
-    sourcemap: true,
-    clean: false,
-    platform: "browser",
-    minify: false,
-    target: "es2018",
-    splitting: false,
-    outExtension() {
-      return {
-        js: ".umd.js"
-      };
-    }
-  }
-]);