@pterodoc/core 0.2.0

package/lib/chunks/paths-Bh6UsRI9.js

@@ -0,0 +1,177 @@
+import 'node:fs';
+import path from 'node:path';
+
+/**
+ * The error types the CLI knows how to present, and the exit codes they map to.
+ *
+ * Codes 0, 1 and 2 keep the meaning the DocStack sync script established, so a
+ * workflow that already branches on them does not change behaviour.
+ */
+const EXIT = {
+    /** Everything asked for was done. */
+    ok: 0,
+    /** The configuration or the command line was wrong; printed without a stack. */
+    config: 1,
+    /** The target refused a request. */
+    target: 2,
+    /** `--strict` was given and an issue reached the configured severity. */
+    strict: 3,
+    /** Something we did not anticipate; printed with a stack. */
+    internal: 4,
+};
+/** Base class for every error this tool raises deliberately. */
+class PterodocError extends Error {
+    /** Exit code the CLI should use. */
+    exitCode;
+    constructor(message, exitCode = EXIT.internal) {
+        super(message);
+        this.name = new.target.name;
+        this.exitCode = exitCode;
+    }
+}
+/** A user-fixable problem with the configuration, the flags or the environment. */
+class ConfigError extends PterodocError {
+    constructor(message) {
+        super(message, EXIT.config);
+    }
+}
+/** The target rejected a request, or could not be reached. */
+class TargetError extends PterodocError {
+    /** HTTP status, or 0 when the request never completed. */
+    status;
+    /** Machine-readable code the target supplied, when it supplied one. */
+    code;
+    /** HTTP method of the failed request. */
+    method;
+    /** URL of the failed request. */
+    url;
+    /** First part of the response body, for diagnosis. */
+    bodySnippet;
+    constructor(message, details) {
+        super(message, EXIT.target);
+        this.status = details.status;
+        this.code = details.code;
+        this.method = details.method;
+        this.url = details.url;
+        this.bodySnippet = details.bodySnippet ?? '';
+    }
+}
+/** Content that this tool cannot represent in the target, when configured to fail on it. */
+class UnsupportedContentError extends PterodocError {
+    constructor(message) {
+        super(message, EXIT.strict);
+    }
+}
+
+/** The tool's own version, stamped into the build. */
+/**
+ * Read the version.
+ *
+ * The build replaces the token, so a built artefact never touches the disk and
+ * does not care how deeply it is nested. Running from source — tsx, the test
+ * suite, an editor — there is no token, and the manifest sits exactly one
+ * directory above this file.
+ *
+ * `typeof` on an undeclared identifier is the one expression that does not
+ * throw, so the ambient declaration costs nothing at runtime.
+ */
+function readVersion() {
+    return "0.2.0";
+}
+/** Semantic version of this package. */
+const VERSION = readVersion();
+/** The User-Agent every outbound request identifies itself with. */
+const USER_AGENT = `pterodoc/${VERSION} (+https://github.com/onyx-ac/pterodoc)`;
+
+/**
+ * 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.
+ */
+/** Prefix Docusaurus uses for paths relative to the site directory. */
+const SITE_ALIAS = '@site/';
+/**
+ * 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.
+ */
+function resolveAliasedPath(aliased, siteDir) {
+    if (!aliased.startsWith(SITE_ALIAS)) {
+        throw new ConfigError(`Expected a "@site/"-relative path from Docusaurus but got "${aliased}". This usually means an unsupported Docusaurus version.`);
+    }
+    return path.resolve(siteDir, aliased.slice(SITE_ALIAS.length));
+}
+/** Turn a host path into the POSIX form used for ids and messages. */
+function toPosix(value) {
+    return value.split(path.sep).join('/');
+}
+/** Split a URL-ish path into its non-empty segments. */
+function segments(value) {
+    return value.split('/').filter(Boolean);
+}
+/**
+ * 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.
+ */
+function toSlugSegments(value, label) {
+    const parts = segments(String(value ?? '').trim());
+    for (const part of parts) {
+        if (!/^[a-z0-9]+(?:[-_][a-z0-9]+)*$/.test(part)) {
+            throw new ConfigError(`${label} segment "${part}" is not a slug. Use lowercase letters, digits, hyphens and underscores.`);
+        }
+    }
+    return parts;
+}
+/**
+ * Make a slug out of arbitrary text, for path segments we derive ourselves
+ * (a version name, for instance) rather than receive from Docusaurus.
+ */
+function slugify(value) {
+    return String(value)
+        .normalize('NFKD')
+        .replace(/[\u0300-\u036f]/g, '')
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '') || 'untitled';
+}
+/** Title-case a slug, for a page that has no better label available. */
+function titleCase(slug) {
+    return segments(slug.replace(/[-_]/g, ' ').replace(/\s+/g, ' '))
+        .join(' ')
+        .split(' ')
+        .filter(Boolean)
+        .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+        .join(' ');
+}
+/**
+ * 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.
+ */
+function relativeToPrefix(url, prefix) {
+    const normalisedPrefix = `/${segments(prefix).join('/')}`;
+    const normalisedUrl = `/${segments(url).join('/')}`;
+    if (normalisedPrefix === '/')
+        return segments(normalisedUrl).join('/');
+    if (normalisedUrl === normalisedPrefix)
+        return '';
+    if (!normalisedUrl.startsWith(`${normalisedPrefix}/`))
+        return undefined;
+    return normalisedUrl.slice(normalisedPrefix.length + 1);
+}
+/** Join path segments into an absolute URL path with a trailing slash. */
+function joinPath(parts, trailingSlash = true) {
+    const joined = parts.flatMap((part) => segments(part)).join('/');
+    if (joined === '')
+        return '/';
+    return trailingSlash ? `/${joined}/` : `/${joined}`;
+}
+
+export { ConfigError as C, EXIT as E, PterodocError as P, TargetError as T, USER_AGENT as U, VERSION as V, UnsupportedContentError as a, resolveAliasedPath as b, slugify as c, toPosix as d, toSlugSegments as e, joinPath as j, relativeToPrefix as r, segments as s, titleCase as t };
+//# sourceMappingURL=paths-Bh6UsRI9.js.map

package/lib/chunks/paths-Bh6UsRI9.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths-Bh6UsRI9.js","sources":["../../src/errors.ts","../../src/version.ts","../../src/util/paths.ts"],"sourcesContent":[null,null,null],"names":[],"mappings":";;;AAAA;;;;;AAKG;AAEI,MAAM,IAAI,GAAG;;AAElB,IAAA,EAAE,EAAE,CAAC;;AAEL,IAAA,MAAM,EAAE,CAAC;;AAET,IAAA,MAAM,EAAE,CAAC;;AAET,IAAA,MAAM,EAAE,CAAC;;AAET,IAAA,QAAQ,EAAE,CAAC;;AAGb;AACM,MAAO,aAAc,SAAQ,KAAK,CAAA;;AAE7B,IAAA,QAAQ;AAEjB,IAAA,WAAA,CAAY,OAAe,EAAE,QAAA,GAAmB,IAAI,CAAC,QAAQ,EAAA;QAC3D,KAAK,CAAC,OAAO,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI;AAC3B,QAAA,IAAI,CAAC,QAAQ,GAAG,QAAQ;IAC1B;AACD;AAED;AACM,MAAO,WAAY,SAAQ,aAAa,CAAA;AAC5C,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC;IAC7B;AACD;AAED;AACM,MAAO,WAAY,SAAQ,aAAa,CAAA;;AAEnC,IAAA,MAAM;;AAEN,IAAA,IAAI;;AAEJ,IAAA,MAAM;;AAEN,IAAA,GAAG;;AAEH,IAAA,WAAW;IAEpB,WAAA,CACE,OAAe,EACf,OAMC,EAAA;AAED,QAAA,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC;AAC3B,QAAA,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;AAC5B,QAAA,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI;AACxB,QAAA,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM;AAC5B,QAAA,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG;QACtB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,EAAE;IAC9C;AACD;AAED;AACM,MAAO,uBAAwB,SAAQ,aAAa,CAAA;AACxD,IAAA,WAAA,CAAY,OAAe,EAAA;AACzB,QAAA,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC;IAC7B;AACD;;AC5ED;AAIA;;;;;;;;;;AAUG;AACH,SAAS,WAAW,GAAA;IAC4B,OAAO,OAAoB;AAQ3E;AAEA;AACO,MAAM,OAAO,GAAG,WAAW;AAElC;AACO,MAAM,UAAU,GAAG,CAAA,SAAA,EAAY,OAAO;;AC9B7C;;;;;AAKG;AAKH;AACA,MAAM,UAAU,GAAG,QAAQ;AAE3B;;;;;AAKG;AACG,SAAU,kBAAkB,CAAC,OAAe,EAAE,OAAe,EAAA;IACjE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;AACnC,QAAA,MAAM,IAAI,WAAW,CACnB,8DAA8D,OAAO,CAAA,wDAAA,CAA0D,CAChI;IACH;AACA,IAAA,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAChE;AAEA;AACM,SAAU,OAAO,CAAC,KAAa,EAAA;AACnC,IAAA,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AACxC;AAEA;AACM,SAAU,QAAQ,CAAC,KAAa,EAAA;IACpC,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AACzC;AAEA;;;;;;AAMG;AACG,SAAU,cAAc,CAAC,KAAa,EAAE,KAAa,EAAA;AACzD,IAAA,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AAClD,IAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC/C,MAAM,IAAI,WAAW,CACnB,CAAA,EAAG,KAAK,CAAA,UAAA,EAAa,IAAI,CAAA,wEAAA,CAA0E,CACpG;QACH;IACF;AACA,IAAA,OAAO,KAAK;AACd;AAEA;;;AAGG;AACG,SAAU,OAAO,CAAC,KAAa,EAAA;IACnC,OAAO,MAAM,CAAC,KAAK;SAChB,SAAS,CAAC,MAAM;AAChB,SAAA,OAAO,CAAC,kBAAkB,EAAE,EAAE;AAC9B,SAAA,WAAW;AACX,SAAA,OAAO,CAAC,aAAa,EAAE,GAAG;AAC1B,SAAA,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,UAAU;AAC1C;AAEA;AACM,SAAU,SAAS,CAAC,IAAY,EAAA;AACpC,IAAA,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SAC5D,IAAI,CAAC,GAAG;SACR,KAAK,CAAC,GAAG;SACT,MAAM,CAAC,OAAO;SACd,GAAG,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;SAC1D,IAAI,CAAC,GAAG,CAAC;AACd;AAEA;;;;;AAKG;AACG,SAAU,gBAAgB,CAAC,GAAW,EAAE,MAAc,EAAA;AAC1D,IAAA,MAAM,gBAAgB,GAAG,CAAA,CAAA,EAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;AACzD,IAAA,MAAM,aAAa,GAAG,CAAA,CAAA,EAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;IACnD,IAAI,gBAAgB,KAAK,GAAG;QAAE,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;IACtE,IAAI,aAAa,KAAK,gBAAgB;AAAE,QAAA,OAAO,EAAE;IACjD,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAA,EAAG,gBAAgB,GAAG,CAAC;AAAE,QAAA,OAAO,SAAS;IACvE,OAAO,aAAa,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;AACzD;AAEA;SACgB,QAAQ,CAAC,KAAe,EAAE,aAAa,GAAG,IAAI,EAAA;IAC5D,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;IAChE,IAAI,MAAM,KAAK,EAAE;AAAE,QAAA,OAAO,GAAG;AAC7B,IAAA,OAAO,aAAa,GAAG,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA,CAAG,GAAG,CAAA,CAAA,EAAI,MAAM,EAAE;AACrD;;"}

package/lib/config/load.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Discovering, merging and validating configuration.
+ *
+ * Precedence is flags, then the environment, then the config file, then the
+ * defaults. Nothing here touches `process.env` or the disk except through the
+ * dependencies it is given, so it is testable without either.
+ */
+import { type PageLayout } from '../render/page';
+import { type Strings } from '../render/theme';
+import type { Severity } from '../util/issues';
+import type { PterodocConfig } from './types';
+/** File names tried, in order, when no config is named. */
+export declare const CONFIG_NAMES: string[];
+/** Flags the CLI can supply, already parsed. */
+export interface ConfigFlags {
+    siteDir?: string | undefined;
+    config?: string | undefined;
+    docusaurusConfig?: string | undefined;
+    model?: string | undefined;
+    instance?: string[] | undefined;
+    locale?: string[] | undefined;
+    allLocales?: boolean | undefined;
+    docsVersion?: string[] | undefined;
+    allVersions?: boolean | undefined;
+    root?: string | undefined;
+    base?: string | undefined;
+    status?: string | undefined;
+    only?: string | undefined;
+    out?: string | undefined;
+    dryRun?: boolean | undefined;
+    prune?: boolean | undefined;
+    offline?: boolean | undefined;
+    noMedia?: boolean | undefined;
+    strict?: boolean | undefined;
+    envFile?: string | undefined;
+}
+/** Everything the run needs, with nothing left to decide. */
+export interface ResolvedConfig {
+    siteDir: string;
+    configFile: string | undefined;
+    docusaurusConfig: string | undefined;
+    modelFile: string | undefined;
+    instances: string[] | 'all';
+    sidebars: string[] | 'all';
+    versions: string[] | 'all' | 'last';
+    locales: string[] | 'all' | 'default';
+    includeDrafts: boolean;
+    includeUnlisted: boolean;
+    includeOrphans: boolean;
+    targetType: 'wordpress';
+    targetUrl: string;
+    user: string;
+    appPassword: string;
+    rootSegments: string[];
+    baseSegments: string[];
+    docsTitle: string;
+    status: 'publish' | 'draft' | 'private';
+    template: string;
+    lang: string;
+    metaDescriptionKey: string;
+    methodOverride: boolean;
+    retry: {
+        attempts: number;
+        baseDelayMs: number;
+        maxDelayMs: number;
+    };
+    layout: PageLayout;
+    classPrefix: string;
+    /** Which block vocabulary the renderer emits. */
+    blocks: 'core' | 'plugin';
+    dedupeTitle: boolean;
+    unpublishedLinks: 'site' | 'drop';
+    siteUrl: string;
+    excerptLength: number;
+    strings: Strings;
+    localeStrings: Record<string, Partial<Strings>>;
+    mdxOnUnknown: 'report' | 'placeholder' | 'error';
+    uploadMedia: boolean;
+    uploadRemoteMedia: boolean;
+    mediaOnMissing: Severity | 'ignore';
+    mediaSlugPrefix: string;
+    outDir: string;
+    writePages: boolean;
+    only: string;
+    dryRun: boolean;
+    prune: boolean;
+    offline: boolean;
+    strict: boolean;
+    strictAt: Severity;
+    /** Told to the user before anything happens. */
+    notices: string[];
+}
+/** Injected so configuration can be resolved without touching the disk. */
+export interface ConfigDeps {
+    readFileSync?: (file: string) => string;
+    existsSync?: (file: string) => boolean;
+    cwd?: () => string;
+}
+/** Find a configuration file next to the site. */
+export declare function discoverConfigFile(siteDir: string, deps: Required<Pick<ConfigDeps, 'existsSync'>>): string | undefined;
+/** Load a configuration file. */
+export declare function readConfigFile(file: string): Promise<PterodocConfig>;
+/**
+ * Resolve everything into the shape the run reads.
+ *
+ * @param input Flags, the file's contents, and the environment.
+ */
+export declare function resolveConfig(input: {
+    flags?: ConfigFlags;
+    file?: PterodocConfig;
+    fileDir?: string;
+    env?: NodeJS.ProcessEnv;
+    configFile?: string | undefined;
+}): ResolvedConfig;
+/**
+ * Discover, read and resolve the configuration.
+ *
+ * @param flags Parsed command line flags.
+ * @param env The environment to read.
+ * @param deps Injected filesystem access.
+ */
+export declare function loadConfig(flags?: ConfigFlags, env?: NodeJS.ProcessEnv, deps?: ConfigDeps): Promise<ResolvedConfig>;
+//# sourceMappingURL=load.d.ts.map

package/lib/config/load.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/config/load.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAOH,OAAO,EAAkB,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAmB,KAAK,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAE9C,2DAA2D;AAC3D,eAAO,MAAM,YAAY,UAMxB,CAAC;AAEF,gDAAgD;AAChD,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACnC,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B;AAED,6DAA6D;AAC7D,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9B,SAAS,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAC5B,QAAQ,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAC3B,QAAQ,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC;IACpC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;IACtC,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;IAExB,UAAU,EAAE,WAAW,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;IACxB,KAAK,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAErE,MAAM,EAAE,UAAU,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhD,YAAY,EAAE,QAAQ,GAAG,aAAa,GAAG,OAAO,CAAC;IAEjD,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,cAAc,EAAE,QAAQ,GAAG,QAAQ,CAAC;IACpC,eAAe,EAAE,MAAM,CAAC;IAExB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;IAEnB,gDAAgD;IAChD,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,2EAA2E;AAC3E,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACxC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC;IACvC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB;AAED,kDAAkD;AAClD,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,GAC7C,MAAM,GAAG,SAAS,CAMpB;AAED,iCAAiC;AACjC,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CA0B1E;AA8CD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE;IACnC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,GAAG,cAAc,CAqIjB;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAC9B,KAAK,GAAE,WAAgB,EACvB,GAAG,GAAE,MAAM,CAAC,UAAwB,EACpC,IAAI,GAAE,UAAe,GACpB,OAAO,CAAC,cAAc,CAAC,CAwBzB"}

package/lib/config/types.d.ts

@@ -0,0 +1,136 @@
+/**
+ * The configuration a site writes, and the resolved shape the tool reads.
+ *
+ * Credentials never appear here: the config names the environment variables
+ * that hold them, so a config file is safe to commit.
+ */
+import type { Severity } from '../util/issues';
+import type { PageLayout } from '../render/page';
+import type { Strings } from '../render/theme';
+/** Which documents to publish. */
+export interface SiteConfig {
+    /** Docusaurus site directory. Relative paths resolve against the config file. */
+    dir?: string;
+    /** Explicit `docusaurus.config.*` path. */
+    config?: string;
+    /** Docs plugin instances to publish, or 'all'. */
+    instances?: string[] | 'all';
+    /** Sidebars to publish. A document no kept sidebar reaches is not published. */
+    sidebars?: string[] | 'all';
+    /** Versions to publish: 'last', 'all', or explicit names. */
+    versions?: string[] | 'all' | 'last';
+    /** Locales to publish: 'default', 'all', or explicit codes. */
+    locales?: string[] | 'all' | 'default';
+    /** Publish documents Docusaurus marks as drafts. */
+    includeDrafts?: boolean;
+    /** Publish documents Docusaurus marks as unlisted. */
+    includeUnlisted?: boolean;
+    /** Publish documents that belong to no sidebar. */
+    includeOrphans?: boolean;
+}
+/** Where to publish. */
+export interface TargetConfig {
+    /** The only implementation today. */
+    type?: 'wordpress';
+    /** Site origin. Usually supplied by the environment instead. */
+    url?: string;
+    /** Which environment variables hold the credentials. */
+    auth?: {
+        userEnv?: string;
+        passwordEnv?: string;
+    };
+    /** Path the documentation tree hangs from. */
+    root?: string;
+    /** Segment below the root holding the docs; '' publishes under the root. */
+    base?: string;
+    /** Title of the documentation root when no document claims it. */
+    title?: string;
+    /** Status applied to every synced page. */
+    status?: 'publish' | 'draft' | 'private';
+    /** Page template slug. */
+    template?: string;
+    /** Polylang language code. */
+    lang?: string;
+    /** Map a rendered field onto a target metadata key. */
+    meta?: {
+        description?: string;
+    };
+    /** Send DELETE as POST with an override header. */
+    methodOverride?: boolean;
+    /** How hard to retry a busy site. */
+    retry?: {
+        attempts?: number;
+        baseDelayMs?: number;
+        maxDelayMs?: number;
+    };
+}
+/** How pages are rendered. */
+export interface RenderConfig {
+    /** Prefix on every generated class name. */
+    classPrefix?: string;
+    /**
+     * Which block vocabulary to emit.
+     *
+     * `core` is the default and emits core blocks only. `plugin` additionally
+     * carries instructions the pterodoc WordPress plugin understands — chiefly
+     * highlighted line ranges, which core blocks cannot express at all — in block
+     * comments rather than in markup, so WordPress stores the same content either
+     * way. Set it once the plugin is installed; `pterodoc doctor` says whether it
+     * is.
+     */
+    blocks?: 'core' | 'plugin';
+    /** Drop a leading H1 that repeats the page title. */
+    dedupeTitle?: boolean;
+    /** Where links to unpublished documents point: the site, or nowhere. */
+    unpublishedLinks?: 'site' | 'drop';
+    /** Overrides the documentation site URL used by `unpublishedLinks: 'site'`. */
+    siteUrl?: string;
+    /** Longest excerpt, in characters. */
+    excerptLength?: number;
+    /** Human strings, overriding the defaults. */
+    strings?: Partial<Strings>;
+    /** Per-locale string overrides. */
+    localeStrings?: Record<string, Partial<Strings>>;
+}
+/** How MDX is handled. */
+export interface MdxConfig {
+    /** What to do about JSX with no translation. */
+    onUnknown?: 'report' | 'placeholder' | 'error';
+}
+/** How assets are handled. */
+export interface MediaConfig {
+    /** Upload local files to the target. */
+    upload?: boolean;
+    /** Also upload files that already point at another origin. */
+    uploadRemote?: boolean;
+    /** What to do when a referenced file is missing. */
+    onMissing?: Severity | 'ignore';
+    /** Prefix of the media slug that carries the content hash. */
+    slugPrefix?: string;
+}
+/** Where the run writes what it did. */
+export interface OutputConfig {
+    /** Directory for rendered pages, the manifest and the plan. */
+    dir?: string;
+    /** Write each rendered page body as a file. */
+    pages?: boolean;
+}
+/** A pterodoc configuration file. */
+export interface PterodocConfig {
+    site?: SiteConfig;
+    target?: TargetConfig;
+    layout?: Partial<PageLayout>;
+    render?: RenderConfig;
+    mdx?: MdxConfig;
+    media?: MediaConfig;
+    output?: OutputConfig;
+    /** With `--strict`, an issue at this severity or above fails the run. */
+    strict?: Severity;
+}
+/**
+ * Identity function that types a configuration file.
+ *
+ * @param config The configuration.
+ */
+export declare function defineConfig(config: PterodocConfig): PterodocConfig;
+//# sourceMappingURL=types.d.ts.map

package/lib/config/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE/C,kCAAkC;AAClC,MAAM,WAAW,UAAU;IACzB,iFAAiF;IACjF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAC7B,gFAAgF;IAChF,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAC5B,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC;IACrC,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;IACvC,oDAAoD;IACpD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,sDAAsD;IACtD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mDAAmD;IACnD,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,wBAAwB;AACxB,MAAM,WAAW,YAAY;IAC3B,qCAAqC;IACrC,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,gEAAgE;IAChE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAClD,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2CAA2C;IAC3C,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IACzC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,IAAI,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChC,mDAAmD;IACnD,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qCAAqC;IACrC,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1E;AAED,8BAA8B;AAC9B,MAAM,WAAW,YAAY;IAC3B,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC3B,qDAAqD;IACrD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,wEAAwE;IACxE,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,+EAA+E;IAC/E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;CAClD;AAED,0BAA0B;AAC1B,MAAM,WAAW,SAAS;IACxB,gDAAgD;IAChD,SAAS,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,OAAO,CAAC;CAChD;AAED,8BAA8B;AAC9B,MAAM,WAAW,WAAW;IAC1B,wCAAwC;IACxC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8DAA8D;IAC9D,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,oDAAoD;IACpD,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAChC,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,wCAAwC;AACxC,MAAM,WAAW,YAAY;IAC3B,+DAA+D;IAC/D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7B,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,yEAAyE;IACzE,MAAM,CAAC,EAAE,QAAQ,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAEnE"}

package/lib/errors.d.ts

@@ -0,0 +1,53 @@
+/**
+ * The error types the CLI knows how to present, and the exit codes they map to.
+ *
+ * Codes 0, 1 and 2 keep the meaning the DocStack sync script established, so a
+ * workflow that already branches on them does not change behaviour.
+ */
+export declare const EXIT: {
+    /** Everything asked for was done. */
+    readonly ok: 0;
+    /** The configuration or the command line was wrong; printed without a stack. */
+    readonly config: 1;
+    /** The target refused a request. */
+    readonly target: 2;
+    /** `--strict` was given and an issue reached the configured severity. */
+    readonly strict: 3;
+    /** Something we did not anticipate; printed with a stack. */
+    readonly internal: 4;
+};
+/** Base class for every error this tool raises deliberately. */
+export declare class PterodocError extends Error {
+    /** Exit code the CLI should use. */
+    readonly exitCode: number;
+    constructor(message: string, exitCode?: number);
+}
+/** A user-fixable problem with the configuration, the flags or the environment. */
+export declare class ConfigError extends PterodocError {
+    constructor(message: string);
+}
+/** The target rejected a request, or could not be reached. */
+export declare class TargetError extends PterodocError {
+    /** HTTP status, or 0 when the request never completed. */
+    readonly status: number;
+    /** Machine-readable code the target supplied, when it supplied one. */
+    readonly code: string | undefined;
+    /** HTTP method of the failed request. */
+    readonly method: string;
+    /** URL of the failed request. */
+    readonly url: string;
+    /** First part of the response body, for diagnosis. */
+    readonly bodySnippet: string;
+    constructor(message: string, details: {
+        status: number;
+        code?: string | undefined;
+        method: string;
+        url: string;
+        bodySnippet?: string;
+    });
+}
+/** Content that this tool cannot represent in the target, when configured to fail on it. */
+export declare class UnsupportedContentError extends PterodocError {
+    constructor(message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/lib/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,IAAI;IACf,qCAAqC;;IAErC,gFAAgF;;IAEhF,oCAAoC;;IAEpC,yEAAyE;;IAEzE,6DAA6D;;CAErD,CAAC;AAEX,gEAAgE;AAChE,qBAAa,aAAc,SAAQ,KAAK;IACtC,oCAAoC;IACpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAEd,OAAO,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAsB;CAK9D;AAED,mFAAmF;AACnF,qBAAa,WAAY,SAAQ,aAAa;gBAChC,OAAO,EAAE,MAAM;CAG5B;AAED,8DAA8D;AAC9D,qBAAa,WAAY,SAAQ,aAAa;IAC5C,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,yCAAyC;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iCAAiC;IACjC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;gBAG3B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CASJ;AAED,4FAA4F;AAC5F,qBAAa,uBAAwB,SAAQ,aAAa;gBAC5C,OAAO,EAAE,MAAM;CAG5B"}

package/lib/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The parts of pterodoc that know neither where a model came from nor where it
+ * is going: rendering, the site model, the target contract and the reconciler.
+ *
+ * Most consumers want the `pterodoc` package instead; this is what the source
+ * and target packages build on.
+ */
+export { EXIT, PterodocError, ConfigError, TargetError, UnsupportedContentError } from './errors';
+export { VERSION, USER_AGENT } from './version';
+export { defineConfig } from './config/types';
+export type { PterodocConfig, SiteConfig, TargetConfig, RenderConfig, MdxConfig, MediaConfig, OutputConfig, } from './config/types';
+export { loadConfig, resolveConfig, discoverConfigFile, CONFIG_NAMES } from './config/load';
+export type { ResolvedConfig, ConfigFlags } from './config/load';
+export { runSync } from './sync/run';
+export type { RunResult, RunSyncDeps } from './sync/run';
+export type { Plan, Action } from './sync/plan';
+export * from './model/index';
+export * from './target/index';
+export { renderDoc, createTheme, composePage, DEFAULT_LAYOUT } from './render/index';
+export type { RenderedDoc, Theme, Strings, PageLayout } from './render/index';
+export { IssueCollector, formatIssue, compareSeverity } from './util/issues';
+export type { Issue, Severity } from './util/issues';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAClG,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EACV,cAAc,EACd,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,SAAS,EACT,WAAW,EACX,YAAY,GACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC5F,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzD,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAChD,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AACrF,YAAY,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAC7E,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}