@pterodoc/core 0.2.0

package/lib/sync/plan.d.ts

@@ -0,0 +1,59 @@
+/** What a run intends to do, and what it did. */
+import type { Issue } from '../util/issues';
+/** One thing a run did, or would do. */
+export interface Action {
+    /** What kind of change this is. */
+    op: 'create-root' | 'create' | 'update' | 'unchanged' | 'prune' | 'upload-media' | 'reuse-media';
+    /** Full path within the published tree, for every operation. */
+    path: string;
+    /** Target id, once it is known. */
+    id?: number | null;
+    /** Fields that differ, for an update. */
+    changed?: string[];
+    /** Source file, when the action belongs to a document. */
+    file?: string | null;
+    /** Locale this action belongs to. */
+    locale?: string;
+    /** Version this action belongs to. */
+    versionName?: string;
+    /** Whether a removal was actually carried out. */
+    applied?: boolean;
+}
+/** The record of a run. */
+export interface Plan {
+    /** When the run started. */
+    generatedAt: string;
+    /** Versions involved, for reproducing a report. */
+    versions: {
+        pterodoc: string;
+        docusaurus: string | null;
+        node: string;
+    };
+    /** True when nothing was written. */
+    dryRun: boolean;
+    /** True when nothing was even read from the target. */
+    offline: boolean;
+    /** The target site, when there is one. */
+    site: string | null;
+    /** Where the documentation was published. */
+    rootPath: string;
+    /** Locales published. */
+    locales: string[];
+    /** Versions published. */
+    versionNames: string[];
+    /** Everything the run did, or would do. */
+    actions: Action[];
+    /** Everything worth telling the user. */
+    issues: Issue[];
+    /** How many of each operation. */
+    summary: Record<string, number>;
+    /** How many requests were made. */
+    requests: number;
+    /** How many files still need uploading; non-zero only on a dry run. */
+    mediaPending: number;
+    /** Set when writing the artefacts itself failed. */
+    artifactError: string | null;
+}
+/** Count the actions by operation. */
+export declare function summarise(actions: Action[]): Record<string, number>;
+//# sourceMappingURL=plan.d.ts.map

package/lib/sync/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../src/sync/plan.ts"],"names":[],"mappings":"AAAA,iDAAiD;AAEjD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,wCAAwC;AACxC,MAAM,WAAW,MAAM;IACrB,mCAAmC;IACnC,EAAE,EACE,aAAa,GACb,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,OAAO,GACP,cAAc,GACd,aAAa,CAAC;IAClB,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,2BAA2B;AAC3B,MAAM,WAAW,IAAI;IACnB,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,QAAQ,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACxE,qCAAqC;IACrC,MAAM,EAAE,OAAO,CAAC;IAChB,uDAAuD;IACvD,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,0BAA0B;IAC1B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,yCAAyC;IACzC,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,YAAY,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,sCAAsC;AACtC,wBAAgB,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAInE"}

package/lib/sync/run.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The reconciler.
+ *
+ * Two phases, because WordPress's navigation block needs a page id before any
+ * body can reference it: first make sure every page exists, then render every
+ * body against the real ids and write only what differs.
+ */
+import { type Issue } from '../util/issues';
+import type { SourceReader } from '../model/reader';
+import type { Target } from '../target/target';
+import type { ResolvedConfig } from '../config/load';
+import { type Plan } from './plan';
+import { type Artifacts } from './artifacts';
+/** What a run needs beyond its configuration. */
+export interface RunSyncDeps {
+    /** Where the site model comes from. */
+    reader: SourceReader;
+    /**
+     * Where pages are published.
+     *
+     * Always supplied, even for a run that publishes nothing: the target owns
+     * URL policy, so rendering needs it to know what a page's address will be.
+     */
+    target?: Target | undefined;
+    /** Render only: build no session and contact nothing. */
+    renderOnly?: boolean | undefined;
+    /** Progress worth seeing under `--verbose`. */
+    log?: (message: string) => void;
+}
+/** What a run produced. */
+export interface RunResult {
+    plan: Plan;
+    artifacts: Artifacts;
+}
+/** Run the sync. */
+export declare function runSync(config: ResolvedConfig, deps: RunSyncDeps): Promise<RunResult>;
+/** Issues, for callers that want them without the plan. */
+export type { Issue };
+//# sourceMappingURL=run.d.ts.map

package/lib/sync/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/sync/run.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAMH,OAAO,EAAkB,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAM5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAMpD,OAAO,KAAK,EAA0B,MAAM,EAAiB,MAAM,kBAAkB,CAAC;AACtF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAA0B,KAAK,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAkB,KAAK,SAAS,EAAsB,MAAM,aAAa,CAAC;AAEjF,iDAAiD;AACjD,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,MAAM,EAAE,YAAY,CAAC;IACrB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,+CAA+C;IAC/C,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC;AAED,2BAA2B;AAC3B,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,EAAE,SAAS,CAAC;CACtB;AAUD,oBAAoB;AACpB,wBAAsB,OAAO,CAAC,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,CA4F3F;AAseD,2DAA2D;AAC3D,YAAY,EAAE,KAAK,EAAE,CAAC"}

package/lib/target/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The target contract: what a place pages are published to must provide.
+ *
+ * Implementations live beside this, or in their own package; the reconciler
+ * only ever sees what is declared here.
+ */
+export type { EnsureRequest, EnsureResult, MediaRef, MediaUpload, RemotePage, RenderedPage, Target, TargetCapabilities, TargetSession, } from './target';
+//# sourceMappingURL=index.d.ts.map

package/lib/target/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/target/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,YAAY,EACV,aAAa,EACb,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,UAAU,EACV,YAAY,EACZ,MAAM,EACN,kBAAkB,EAClB,aAAa,GACd,MAAM,UAAU,CAAC"}

package/lib/target/index.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=index.js.map

package/lib/target/index.js.map

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

package/lib/target/target.d.ts

@@ -0,0 +1,152 @@
+/**
+ * What a publishing target has to be able to do.
+ *
+ * WordPress is the only implementation today, but keeping the contract
+ * explicit is what stops target vocabulary leaking into the renderer and the
+ * reconciler.
+ */
+/** What a target can and cannot do. */
+export interface TargetCapabilities {
+    /** Page ids must exist before bodies can be rendered, as WordPress's page list needs. */
+    needsIdsBeforeRender: boolean;
+    /** Files can be uploaded and referenced. */
+    supportsMedia: boolean;
+    /** Pages with no source can be removed. */
+    supportsPrune: boolean;
+    /** Pages nest; a flat target gets its whole path as one name. */
+    supportsHierarchy: boolean;
+    /** There is a separate summary field. */
+    supportsExcerpt: boolean;
+    /** Arbitrary key/value metadata can be written. */
+    supportsMeta: boolean;
+    /** A page can be given a template. */
+    supportsTemplates: boolean;
+    /** A page can be created unpublished. */
+    supportsDrafts: boolean;
+}
+/** A page as it exists on the target. */
+export interface RemotePage {
+    id: number;
+    parent: number;
+    slug: string;
+    status: string;
+    link: string;
+    title: string;
+    content?: string;
+    excerpt?: string;
+    menuOrder: number;
+    template: string;
+    meta?: Record<string, unknown> | undefined;
+}
+/** A page as pterodoc would publish it. */
+export interface RenderedPage {
+    /** Path within the published tree. */
+    path: string;
+    /** Slug of the last path segment. */
+    slug: string;
+    /** Page title. */
+    title: string;
+    /** The composed body. */
+    content: string;
+    /** Short summary. */
+    excerpt: string;
+    /** Position among siblings. */
+    menuOrder: number;
+    /** Metadata to write, when the target supports it. */
+    meta: Record<string, string>;
+    /** Source file, for messages. */
+    file?: string | undefined;
+    /** Version this page belongs to. */
+    versionName?: string | undefined;
+}
+/** A file to upload. */
+export interface MediaUpload {
+    bytes: Uint8Array;
+    filename: string;
+    hash: string;
+    mime: string;
+    alt: string;
+    title: string;
+}
+/** An uploaded file. */
+export interface MediaRef {
+    id: number;
+    hash: string;
+    url: string;
+    filename: string;
+    mime: string;
+}
+/** Asking the target to make sure a page exists. */
+export interface EnsureRequest {
+    path: string;
+    slug: string;
+    parentId: number | null;
+    title: string;
+    menuOrder: number;
+    isRoot: boolean;
+}
+/** What came of that. */
+export interface EnsureResult {
+    id: number | null;
+    created: boolean;
+    warnings: string[];
+}
+/** An open connection to a target. */
+export interface TargetSession {
+    /** Every page under the target's namespace, fetched once. */
+    loadIndex(): Promise<RemotePage[]>;
+    /**
+     * Make sure everything above the documentation root exists.
+     *
+     * The target owns this because only it knows what a path is made of. Pages
+     * it has to create are reported so the plan can show them; pages that were
+     * already there are never touched.
+     */
+    ensureRootParent(): Promise<{
+        id: number | null;
+        created: {
+            path: string;
+            id: number | null;
+        }[];
+    }>;
+    /** Make sure a page exists at this position, and give back its id. */
+    ensurePage(request: EnsureRequest): Promise<EnsureResult>;
+    /** Fetch a page with the fields needed to compare it. */
+    fetchPage(id: number): Promise<RemotePage>;
+    /** Which fields of an existing page differ from the rendered one. */
+    diffPage(remote: RemotePage, rendered: RenderedPage, parentId: number): string[];
+    /** Write a rendered page, returning warnings for anything the target refused. */
+    writePage(id: number, page: RenderedPage, parentId: number): Promise<{
+        warnings: string[];
+    }>;
+    /** Pages below a root that no rendered page accounts for, deepest first. */
+    computePrune(index: RemotePage[], rootId: number, keepIds: Set<number>): RemotePage[];
+    /** Remove a page. Never a permanent delete. */
+    removePage(page: RemotePage): Promise<void>;
+    /** Files already uploaded, by content hash. */
+    loadMediaIndex(): Promise<Map<string, MediaRef>>;
+    /** Upload one file. */
+    uploadMedia(upload: MediaUpload): Promise<MediaRef>;
+    /** How many requests this session has made. */
+    requestCount(): number;
+}
+/** A place documentation can be published. */
+export interface Target {
+    /** Name used in messages and in the plan. */
+    readonly name: string;
+    /** What this target can do. */
+    readonly capabilities: TargetCapabilities;
+    /** Absolute site path for a tree path: the target owns URL policy. */
+    hrefFor(treePath: string, context: {
+        versionName: string;
+        locale: string;
+    }): string;
+    /** The path pages are published under, for messages. */
+    readonly rootPath: string;
+    /** Open a session. */
+    open(context: {
+        locale: string;
+        dryRun: boolean;
+    }): Promise<TargetSession>;
+}
+//# sourceMappingURL=target.d.ts.map

package/lib/target/target.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"target.d.ts","sourceRoot":"","sources":["../../src/target/target.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,oBAAoB,EAAE,OAAO,CAAC;IAC9B,4CAA4C;IAC5C,aAAa,EAAE,OAAO,CAAC;IACvB,2CAA2C;IAC3C,aAAa,EAAE,OAAO,CAAC;IACvB,iEAAiE;IACjE,iBAAiB,EAAE,OAAO,CAAC;IAC3B,yCAAyC;IACzC,eAAe,EAAE,OAAO,CAAC;IACzB,mDAAmD;IACnD,YAAY,EAAE,OAAO,CAAC;IACtB,sCAAsC;IACtC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,yCAAyC;IACzC,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,yCAAyC;AACzC,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CAC5C;AAED,2CAA2C;AAC3C,MAAM,WAAW,YAAY;IAC3B,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED,wBAAwB;AACxB,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,UAAU,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAwB;AACxB,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oDAAoD;AACpD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,yBAAyB;AACzB,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,sCAAsC;AACtC,MAAM,WAAW,aAAa;IAC5B,6DAA6D;IAC7D,SAAS,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IACnC;;;;;;OAMG;IACH,gBAAgB,IAAI,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,OAAO,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC,CAAC;IACnG,sEAAsE;IACtE,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1D,yDAAyD;IACzD,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,qEAAqE;IACrE,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjF,iFAAiF;IACjF,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IAC7F,4EAA4E;IAC5E,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,UAAU,EAAE,CAAC;IACtF,+CAA+C;IAC/C,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,+CAA+C;IAC/C,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IACjD,uBAAuB;IACvB,WAAW,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACpD,+CAA+C;IAC/C,YAAY,IAAI,MAAM,CAAC;CACxB;AAED,8CAA8C;AAC9C,MAAM,WAAW,MAAM;IACrB,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,+BAA+B;IAC/B,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC;IAC1C,sEAAsE;IACtE,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC;IACpF,wDAAwD;IACxD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,sBAAsB;IACtB,IAAI,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;CAC5E"}

package/lib/util/hash.d.ts

@@ -0,0 +1,10 @@
+/** Content hashing, used to give an uploaded asset a stable identity. */
+/**
+ * A short content hash.
+ *
+ * Sixteen hex characters of SHA-256: long enough that a collision across one
+ * site's assets is not a practical concern, short enough to sit inside a
+ * WordPress slug without dominating it.
+ */
+export declare function contentHash(bytes: Uint8Array | string): string;
+//# sourceMappingURL=hash.d.ts.map

package/lib/util/hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../src/util/hash.ts"],"names":[],"mappings":"AAAA,yEAAyE;AAIzE;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,MAAM,CAE9D"}

package/lib/util/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Shared helpers with no domain knowledge, and the errors every layer throws.
+ *
+ * Nothing here imports another layer, which is what makes it safe for all of
+ * them to import it.
+ */
+export { EXIT, PterodocError, ConfigError, TargetError, UnsupportedContentError } from '../errors';
+export { VERSION, USER_AGENT } from '../version';
+export { contentHash } from './hash';
+export { compareSeverity, formatIssue, IssueCollector } from './issues';
+export type { Issue, Severity } from './issues';
+export { mimeTypeFor, isBlockedByDefault } from './mime';
+export { joinPath, relativeToPrefix, resolveAliasedPath, segments, slugify, titleCase, toPosix, toSlugSegments, } from './paths';
+//# sourceMappingURL=index.d.ts.map

package/lib/util/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACnG,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AACxE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAC;AACzD,OAAO,EACL,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,QAAQ,EACR,OAAO,EACP,SAAS,EACT,OAAO,EACP,cAAc,GACf,MAAM,SAAS,CAAC"}

package/lib/util/index.js

@@ -0,0 +1,7 @@
+export { C as ConfigError, E as EXIT, P as PterodocError, T as TargetError, U as USER_AGENT, a as UnsupportedContentError, V as VERSION, j as joinPath, r as relativeToPrefix, b as resolveAliasedPath, s as segments, c as slugify, t as titleCase, d as toPosix, e as toSlugSegments } from '../chunks/paths-Bh6UsRI9.js';
+export { c as contentHash, i as isBlockedByDefault, m as mimeTypeFor } from '../chunks/mime-2SUyOolJ.js';
+export { I as IssueCollector, c as compareSeverity, f as formatIssue } from '../chunks/issues-DBsPh6ek.js';
+import 'node:fs';
+import 'node:path';
+import 'node:crypto';
+//# sourceMappingURL=index.js.map

package/lib/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/lib/util/issues.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Structured diagnostics.
+ *
+ * Everything a run wants to tell the user goes through here rather than into
+ * free-form strings, so the CLI can group them, `--json` can emit them, and
+ * `--strict` can decide whether they should fail the run.
+ */
+/** How much a reader should care. */
+export type Severity = 'info' | 'warning' | 'error';
+/** One thing worth telling the user about. */
+export interface Issue {
+    /** Stable identifier, e.g. `mdx-unknown-component`. Never localised. */
+    code: string;
+    /** How much a reader should care. */
+    severity: Severity;
+    /** One sentence, in English, naming what happened. */
+    message: string;
+    /** Source file the issue came from, relative to the site directory. */
+    file?: string | undefined;
+    /** One-based line within `file`. */
+    line?: number | undefined;
+    /** One-based column within `line`. */
+    column?: number | undefined;
+    /** Document id, when the issue belongs to a document. */
+    docId?: string | undefined;
+    /** Page path within the target tree, when the issue belongs to a page. */
+    path?: string | undefined;
+}
+/** Accumulates issues during a run. */
+export declare class IssueCollector {
+    readonly issues: Issue[];
+    /** Record an issue. */
+    add(issue: Issue): void;
+    /** Record an issue that inherits a document's file and id. */
+    addFor(doc: {
+        id: string;
+        sourceRelativePath?: string;
+    } | undefined, issue: Omit<Issue, 'docId' | 'file'> & {
+        file?: string;
+    }): void;
+    /** True when any issue is at least as severe as `severity`. */
+    hasAtLeast(severity: Severity): boolean;
+    /** Issues at least as severe as `severity`. */
+    atLeast(severity: Severity): Issue[];
+    /** How many issues carry each code, for a compact summary. */
+    countByCode(): Record<string, number>;
+}
+/** Compare two severities; positive when `a` is more severe than `b`. */
+export declare function compareSeverity(a: Severity, b: Severity): number;
+/** Render an issue as one line, with its position when it has one. */
+export declare function formatIssue(issue: Issue): string;
+//# sourceMappingURL=issues.d.ts.map

package/lib/util/issues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"issues.d.ts","sourceRoot":"","sources":["../../src/util/issues.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,qCAAqC;AACrC,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;AAIpD,8CAA8C;AAC9C,MAAM,WAAW,KAAK;IACpB,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,qCAAqC;IACrC,QAAQ,EAAE,QAAQ,CAAC;IACnB,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B;AAED,uCAAuC;AACvC,qBAAa,cAAc;IACzB,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAM;IAE9B,uBAAuB;IACvB,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAIvB,8DAA8D;IAC9D,MAAM,CACJ,GAAG,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,EAC5D,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GACvD,IAAI;IAQP,+DAA+D;IAC/D,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAIvC,+CAA+C;IAC/C,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,KAAK,EAAE;IAIpC,8DAA8D;IAC9D,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAKtC;AAED,yEAAyE;AACzE,wBAAgB,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,MAAM,CAEhE;AAED,sEAAsE;AACtE,wBAAgB,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAOhD"}

package/lib/util/mime.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Extension to media type.
+ *
+ * A twenty-entry table rather than a dependency: these are the types a
+ * documentation site actually embeds, and WordPress rejects most others.
+ */
+/** The media type for a file name, or undefined when we do not recognise it. */
+export declare function mimeTypeFor(fileName: string): string | undefined;
+/**
+ * True for types WordPress refuses by default.
+ *
+ * SVG is the one that surprises people: it is blocked unless a plugin allows
+ * it, because an SVG can carry script.
+ */
+export declare function isBlockedByDefault(mime: string): boolean;
+//# sourceMappingURL=mime.d.ts.map

package/lib/util/mime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mime.d.ts","sourceRoot":"","sources":["../../src/util/mime.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA0BH,gFAAgF;AAChF,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAIhE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAExD"}

package/lib/util/paths.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Path helpers shared by the source reader and the targets.
+ *
+ * Everything here is POSIX-shaped: a documentation tree is addressed by URL
+ * paths, not by the host's separators.
+ */
+/**
+ * Resolve a Docusaurus `@site/...` path to an absolute one.
+ *
+ * @param aliased The path as Docusaurus records it, e.g. `@site/docs/intro.md`.
+ * @param siteDir Absolute path of the Docusaurus site directory.
+ */
+export declare function resolveAliasedPath(aliased: string, siteDir: string): string;
+/** Turn a host path into the POSIX form used for ids and messages. */
+export declare function toPosix(value: string): string;
+/** Split a URL-ish path into its non-empty segments. */
+export declare function segments(value: string): string[];
+/**
+ * Split a configured path into slug segments, rejecting anything WordPress
+ * would not accept as a page slug.
+ *
+ * @param value A path such as `/products/docstack`.
+ * @param label The setting's name, used in the error message.
+ */
+export declare function toSlugSegments(value: string, label: string): string[];
+/**
+ * Make a slug out of arbitrary text, for path segments we derive ourselves
+ * (a version name, for instance) rather than receive from Docusaurus.
+ */
+export declare function slugify(value: string): string;
+/** Title-case a slug, for a page that has no better label available. */
+export declare function titleCase(slug: string): string;
+/**
+ * The path a URL points at below a prefix.
+ *
+ * Returns undefined when `url` is not under `prefix`, which is how the link
+ * resolver decides whether a link belongs to the documentation at all.
+ */
+export declare function relativeToPrefix(url: string, prefix: string): string | undefined;
+/** Join path segments into an absolute URL path with a trailing slash. */
+export declare function joinPath(parts: string[], trailingSlash?: boolean): string;
+//# sourceMappingURL=paths.d.ts.map

package/lib/util/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/util/paths.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAO3E;AAED,sEAAsE;AACtE,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED,wDAAwD;AACxD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAUrE;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAO7C;AAED,wEAAwE;AACxE,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAO9C;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOhF;AAED,0EAA0E;AAC1E,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,aAAa,UAAO,GAAG,MAAM,CAItE"}

package/lib/version.d.ts

@@ -0,0 +1,6 @@
+/** The tool's own version, stamped into the build. */
+/** Semantic version of this package. */
+export declare const VERSION: string;
+/** The User-Agent every outbound request identifies itself with. */
+export declare const USER_AGENT: string;
+//# sourceMappingURL=version.d.ts.map

package/lib/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,sDAAsD;AA0BtD,wCAAwC;AACxC,eAAO,MAAM,OAAO,QAAgB,CAAC;AAErC,oEAAoE;AACpE,eAAO,MAAM,UAAU,QAA+D,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@pterodoc/core",
+  "version": "0.2.0",
+  "description": "Rendering, the site model, the target contract and the reconciler behind pterodoc.",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": { "types": "./lib/index.d.ts", "default": "./lib/index.js" },
+    "./model": { "types": "./lib/model/index.d.ts", "default": "./lib/model/index.js" },
+    "./render": { "types": "./lib/render/index.d.ts", "default": "./lib/render/index.js" },
+    "./target": { "types": "./lib/target/index.d.ts", "default": "./lib/target/index.js" },
+    "./util": { "types": "./lib/util/index.d.ts", "default": "./lib/util/index.js" },
+    "./package.json": "./package.json"
+  },
+  "files": ["lib", "src", "README.md", "LICENCE.md"],
+  "engines": { "node": ">=20.11" },
+  "scripts": {
+    "build": "tsc -b --force && rollup -c",
+    "test": "node ../../scripts/tests.mjs unit"
+  },
+  "dependencies": {
+    "@types/github-slugger": "^1.3.0",
+    "@types/hast": "^3.0.4",
+    "@types/mdast": "^4.0.4",
+    "dotenv": "^16.4.5",
+    "github-slugger": "1.5.0",
+    "gray-matter": "^4.0.3",
+    "hast-util-to-html": "^9.0.5",
+    "mdast-util-to-hast": "^13.2.0",
+    "mdast-util-to-string": "^4.0.0",
+    "remark-directive": "^3.0.1",
+    "remark-frontmatter": "^5.0.0",
+    "remark-gfm": "^4.0.1",
+    "remark-mdx": "^3.1.0",
+    "remark-parse": "^11.0.0",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.1.0"
+  },
+  "repository": { "type": "git", "url": "git+https://github.com/onyx-ac/pterodoc.git" },
+  "license": "CC-BY-SA-4.0",
+  "publishConfig": { "access": "public" }
+}