@storyteller-platform/epub 0.8.2 → 1.0.1

package/dist/jsx-dev-runtime.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Development-mode entry point used by the JSX transform.
+ *
+ * Transforms compiling in development mode import `jsxDEV` from
+ * `<jsxImportSource>/jsx-dev-runtime` rather than from `<jsxImportSource>/jsx-runtime`,
+ * so the subpath has to resolve. There is no separate development behaviour
+ * here: XML has no key reconciliation to warn about.
+ */
+export { Fragment, jsx, jsxDEV, jsxs } from "./jsx-runtime.ts";

package/dist/jsx-dev-runtime.js

@@ -0,0 +1,9 @@
+/**
+ * Development-mode entry point used by the JSX transform.
+ *
+ * Transforms compiling in development mode import `jsxDEV` from
+ * `<jsxImportSource>/jsx-dev-runtime` rather than from `<jsxImportSource>/jsx-runtime`,
+ * so the subpath has to resolve. There is no separate development behaviour
+ * here: XML has no key reconciliation to warn about.
+ */
+export { Fragment, jsx, jsxDEV, jsxs } from "./jsx-runtime.js";

package/dist/jsx-runtime.d.ts

@@ -0,0 +1,42 @@
+/**
+ * A JSX runtime that builds XML DOM nodes.
+ *
+ * Enable it per project with `jsx: "react-jsx"` and
+ * `jsxImportSource: "@storyteller-platform/epub"`.
+ *
+ * Everything is built through {@link x}, so namespaces behave exactly as they do
+ * when calling `x()` directly: a `dc:` prefix resolves to the Dublin Core
+ * namespace, and an `xmlns` attribute binds the namespace it declares instead of
+ * being emitted as an extra attribute.
+ */
+import { type Element as DomElement, type Node } from "@xmldom/xmldom";
+/** Anything a JSX expression may place in a child position. */
+export type JsxChild = Node | string | number | boolean | null | undefined | JsxChild[];
+/** Anything a JSX attribute may evaluate to. */
+export type JsxAttr = string | number | boolean | null | undefined;
+type JsxProps = {
+    children?: JsxChild | undefined;
+    key?: unknown;
+} & Record<string, JsxAttr>;
+/**
+ * Groups children without contributing an element.
+ *
+ * The result is a plain array of children, which {@link flatten} splices into
+ * the parent.
+ */
+export declare function Fragment(props: {
+    children?: JsxChild | undefined;
+}): Array<Node | string>;
+export declare function jsx(type: string | typeof Fragment, props?: JsxProps | null, _key?: unknown): DomElement;
+export declare function jsxs(type: string | typeof Fragment, props?: JsxProps | null, _key?: unknown): DomElement;
+export declare function jsxDEV(type: string | typeof Fragment, props?: JsxProps | null, _key?: unknown): DomElement;
+export declare namespace JSX {
+    type Element = DomElement;
+    interface ElementChildrenAttribute {
+        children: JsxChild;
+    }
+    interface IntrinsicElements {
+        [name: string]: Record<string, JsxChild>;
+    }
+}
+export {};

package/dist/jsx-runtime.js

@@ -0,0 +1,69 @@
+/**
+ * A JSX runtime that builds XML DOM nodes.
+ *
+ * Enable it per project with `jsx: "react-jsx"` and
+ * `jsxImportSource: "@storyteller-platform/epub"`.
+ *
+ * Everything is built through {@link x}, so namespaces behave exactly as they do
+ * when calling `x()` directly: a `dc:` prefix resolves to the Dublin Core
+ * namespace, and an `xmlns` attribute binds the namespace it declares instead of
+ * being emitted as an extra attribute.
+ */
+import { x } from "./xml.js";
+/**
+ * Groups children without contributing an element.
+ *
+ * The result is a plain array of children, which {@link flatten} splices into
+ * the parent.
+ */
+export function Fragment(props) {
+    return flatten(props.children);
+}
+function flatten(child) {
+    if (child === null || child === undefined || typeof child === "boolean") {
+        return [];
+    }
+    if (Array.isArray(child)) {
+        return child.flatMap((c) => flatten(c));
+    }
+    if (typeof child === "number") {
+        return [String(child)];
+    }
+    return [child];
+}
+/**
+ * Attribute values follow XML, not HTML: `null`, `undefined` and `false` leave
+ * the attribute off entirely, `true` writes an empty value, and numbers are
+ * stringified.
+ */
+function attributeValue(value) {
+    // Only `true` reaches here; `false` is dropped by the caller.
+    if (typeof value === "boolean")
+        return "";
+    return String(value);
+}
+function isFragment(type) {
+    return type === Fragment;
+}
+function build(type, props) {
+    const { children, key: _key, ...attributes } = props ?? {};
+    if (isFragment(type)) {
+        return Fragment({ children });
+    }
+    const attrs = {};
+    for (const [name, value] of Object.entries(attributes)) {
+        if (value === null || value === undefined || value === false)
+            continue;
+        attrs[name] = attributeValue(value);
+    }
+    return x(type, attrs, ...flatten(children));
+}
+export function jsx(type, props, _key) {
+    return build(type, props);
+}
+export function jsxs(type, props, _key) {
+    return build(type, props);
+}
+export function jsxDEV(type, props, _key) {
+    return build(type, props);
+}

package/dist/upgrade.d.ts

@@ -1,4 +1,6 @@
-import { Epub, type NavigationItem, type PackageElement, type XmlElement } from "./index.ts";
+/** @jsxImportSource @storyteller-platform/epub */
+import { type Document, type Element } from "@xmldom/xmldom";
+import { type Epub, type NavigationItem } from "./index.tsx";
 export interface Landmark {
     href: string;
     title: string;
@@ -14,23 +16,30 @@ export interface Epub2UpgradeOptions {
      */
     removeNcx?: boolean;
 }
-export declare function upgradeIdentifiers(pkg: PackageElement): void;
-export declare function upgradeTitle(pkg: PackageElement): void;
-export declare function upgradeLanguages(pkg: PackageElement): void;
-export declare function upgradeAuthors(pkg: PackageElement): void;
-export declare function upgradeDate(pkg: PackageElement): void;
-export declare function upgradeMeta(pkg: PackageElement): void;
-export declare function upgradeCover(pkg: PackageElement): void;
-export declare function removeInvalidDcAttrs(pkg: PackageElement): void;
-export declare function setLastModified(pkg: PackageElement): void;
-export declare function upgradePackageMetadata(pkg: PackageElement): void;
-export declare function extractGuideLandmarks(pkg: PackageElement): Landmark[];
-export declare function removeGuide(pkg: PackageElement): void;
-export declare function removeSpineTocRef(pkg: PackageElement): void;
+/**
+ * Replace an outdated document type declaration with `<!DOCTYPE html>`.
+ *
+ * EPUB 3 XHTML content documents must conform to the HTML5 conformance
+ * criteria, which require `<!DOCTYPE html>`.
+ */
+export declare function normalizeDoctype(doc: Document): void;
+export declare function upgradeIdentifiers(pkg: Element): void;
+export declare function upgradeTitle(pkg: Element): void;
+export declare function upgradeLanguages(pkg: Element): void;
+export declare function upgradeAuthors(pkg: Element): void;
+export declare function upgradeDate(pkg: Element): void;
+export declare function upgradeMeta(pkg: Element): void;
+export declare function upgradeCover(pkg: Element): void;
+export declare function removeInvalidDcAttrs(pkg: Element): void;
+export declare function setLastModified(pkg: Element): void;
+export declare function upgradePackageMetadata(pkg: Element): void;
+export declare function extractGuideLandmarks(pkg: Element): Landmark[];
+export declare function removeGuide(pkg: Element): void;
+export declare function removeSpineTocRef(pkg: Element): void;
 export declare function collectManifestProperties(epub: Epub): Promise<void>;
-export declare function fixFontMimeTypes(pkg: PackageElement): void;
-export declare function buildTocOl(entries: NavigationItem[]): XmlElement<"ol">;
+export declare function fixFontMimeTypes(pkg: Element): void;
+export declare function buildTocOl(entries: NavigationItem[]): Element;
 export declare function buildNavDocument(epub: Epub, tocEntries: NavigationItem[], landmarks: Landmark[]): Promise<string>;
-export declare function setPackageVersion(pkg: PackageElement, version: string): void;
+export declare function setPackageVersion(pkg: Element, version: string): void;
 export declare function chooseNavHref(epub: Epub): Promise<string>;
 export declare function removeNcx(epub: Epub): Promise<void>;