@canopycanopycanopy/b-ber-lib 3.0.8-nav.0 → 3.0.8-next.100

package/dist/index.d.ts

@@ -0,0 +1,364 @@
+import YAWN from "yawn-yaml/cjs/index.js";
+
+//#region \0rolldown/runtime.js
+//#endregion
+//#region src/Config.d.ts
+interface ConfigOptions {
+  env: string;
+  src: string;
+  dist: string;
+  cache: boolean;
+  ibooks_specified_fonts: boolean;
+  theme: string;
+  themes_directory: string;
+  base_url: string;
+  base_path: string;
+  remote_url: string;
+  reader_url: string;
+  downloads: unknown[];
+  ui_options: Record<string, unknown>;
+  private: boolean;
+  ignore: unknown[];
+  autoprefixer_options: Record<string, unknown>;
+  layout: string;
+  group_footnotes: boolean;
+  [key: string]: unknown;
+}
+//#endregion
+//#region src/EbookConvert.d.ts
+interface ConvertOptions {
+  inputPath: string;
+  outputPath: string;
+  fileType: string;
+  fileName?: string;
+  flags?: string[];
+  bookPath?: string;
+}
+declare function convert(options: ConvertOptions): Promise<unknown>;
+declare const _default: {
+  convert: typeof convert;
+};
+//#endregion
+//#region src/GuideItem.d.ts
+declare class GuideItem {
+  fileName: string;
+  title: string;
+  type: string;
+  constructor({
+    fileName,
+    title,
+    type
+  }: {
+    fileName: string;
+    title: string;
+    type: string;
+  });
+}
+//#endregion
+//#region src/Html.d.ts
+declare class Html {
+  static comment(str: string): string;
+  static escape(str: unknown): string;
+}
+//#endregion
+//#region src/HtmlToXml.d.ts
+interface HtmlToXmlParserOptions {
+  content: string;
+  onEndCallback: (output: string) => void;
+}
+declare class HtmlToXmlParser {
+  customElementNames: Record<string, boolean>;
+  inlineElementNames: Record<string, boolean>;
+  whitelistedAttributes: Record<string, boolean>;
+  blacklistedTagNames: Record<string, boolean>;
+  containingTagNames: Record<string, boolean>;
+  elementAttributeNames: Record<string, Record<string, string>>;
+  elementAttributeTransformers: Record<string, Record<string, (value: string) => string>>;
+  content: string;
+  onEndCallback: (output: string) => void;
+  output: string;
+  tagList: string[];
+  constructor({
+    content,
+    onEndCallback
+  }: HtmlToXmlParserOptions);
+  writePageBreak(): void;
+  writeXMLDeclaration(): void;
+  renameAttribute(name: string, attribute: string): string;
+  transformAttributeValue(name: string, attribute: string, value: string): string;
+  writeTagOpen(name: string, attributes?: Record<string, string>): void;
+  writeTagClose(name: string): void;
+  addTag(name: string): void;
+  removeTag(): string | undefined;
+  getTag(): string | null;
+  onopentag(name: string, attributes?: Record<string, string>): void;
+  ontext(text: string): void;
+  onclosetag(): void;
+  onend(): void;
+  parse(): void;
+}
+//#endregion
+//#region src/ManifestItemProperties.d.ts
+interface ManifestFile {
+  absolutePath: string;
+  name: string;
+}
+interface DCMetaEntry {
+  term?: string;
+  [key: string]: unknown;
+}
+declare class ManifestItemProperties {
+  static HTMLMimeTypes: string[];
+  static isHTML(file: ManifestFile): boolean;
+  static isNav(file: ManifestFile): boolean;
+  static isScripted(file: ManifestFile): boolean;
+  static isSVG(file: ManifestFile): boolean;
+  static isDCElement(data: DCMetaEntry): boolean;
+  static isDCTerm(data: DCMetaEntry): boolean;
+  static hasRemoteResources(file: ManifestFile): boolean;
+  static testHTML(file: ManifestFile): string[];
+  static testMeta(data: DCMetaEntry): {
+    term: boolean;
+    element: boolean;
+  };
+}
+//#endregion
+//#region src/SpineItem.d.ts
+interface SpineItemOptions {
+  fileName: string;
+  in_toc?: boolean;
+  linear?: boolean;
+  generated?: boolean;
+  pageOrder?: number;
+  buildType: string;
+  nodes?: SpineItem[];
+  ref?: string | null;
+  title?: string;
+}
+declare class SpineItem {
+  fileName: string;
+  pageOrder: number;
+  in_toc: boolean;
+  linear: boolean;
+  generated: boolean;
+  nodes: SpineItem[];
+  ref: string | null;
+  title: string;
+  relativePath: string;
+  absolutePath: string;
+  extension: string;
+  name: string;
+  remotePath: string;
+  type: string;
+  static isNavigationDocument(fileName: string): boolean;
+  constructor({
+    fileName,
+    in_toc,
+    linear,
+    generated,
+    pageOrder,
+    buildType,
+    nodes,
+    ref,
+    title
+  }: SpineItemOptions);
+}
+//#endregion
+//#region src/Spine.d.ts
+interface SpineOptions {
+  src: string;
+  buildType: string;
+  navigationConfigFile: string;
+}
+declare class Spine {
+  src: string;
+  buildType: string;
+  frontMatter: Map<string, Record<string, unknown>>;
+  navigationConfigFile: string;
+  entries: any[];
+  nested: SpineItem[];
+  flattened: Omit<SpineItem, 'nodes'>[];
+  constructor({
+    src,
+    buildType,
+    navigationConfigFile
+  }: SpineOptions);
+  build(entries?: any[]): SpineItem[];
+  flattenNodes(arr: SpineItem[]): Omit<SpineItem, 'nodes'>[];
+  flattenYAML(data?: any[]): string[];
+  create(): any[];
+}
+//#endregion
+//#region src/Yaml.d.ts
+declare class Yaml {
+  data: InstanceType<typeof YAWN>;
+  schema: string;
+  strict: boolean;
+  constructor(schema: string, strict?: boolean);
+  load: (file: string) => void;
+  add: (entry: any) => void;
+  remove: (key: string, value: unknown) => void;
+  update: (key: string, current: unknown, object: Record<string, any>) => void;
+  yaml: () => string;
+  json: () => any;
+}
+//#endregion
+//#region src/State.d.ts
+type ThemeModule = any;
+type BuildSettings = Record<string, any>;
+declare class State {
+  static get defaults(): {
+    build: string;
+    sequence: unknown[];
+    hash: string;
+  };
+  metadata: Yaml;
+  theme: ThemeModule;
+  video: string[];
+  audio: string[];
+  media: any;
+  build: string;
+  sequence: unknown[];
+  hash: string;
+  builds: Record<string, BuildSettings>;
+  config: ConfigOptions;
+  version: string;
+  get spine(): Spine;
+  set spine(val: Spine);
+  get guide(): unknown[];
+  set guide(val: unknown[]);
+  get figures(): unknown[];
+  set figures(val: unknown[]);
+  get footnotes(): unknown[];
+  set footnotes(val: unknown[]);
+  get cursor(): unknown[];
+  set cursor(val: unknown[]);
+  get toc(): unknown[];
+  set toc(val: unknown[]);
+  get remoteAssets(): unknown[];
+  set remoteAssets(val: unknown[]);
+  get loi(): unknown[];
+  set loi(val: unknown[]);
+  get srcDir(): string;
+  set srcDir(val: string);
+  get distDir(): string;
+  set distDir(val: string);
+  get env(): string;
+  set env(val: string);
+  src: {
+    root: (...args: string[]) => string;
+    images: (...args: string[]) => string;
+    markdown: (...args: string[]) => string;
+    stylesheets: (...args: string[]) => string;
+    javascripts: (...args: string[]) => string;
+    fonts: (...args: string[]) => string;
+    media: (...args: string[]) => string;
+  };
+  dist: {
+    root: (...args: string[]) => string;
+    ops: (...args: string[]) => string;
+    text: (...args: string[]) => string;
+    images: (...args: string[]) => string;
+    stylesheets: (...args: string[]) => string;
+    javascripts: (...args: string[]) => string;
+    fonts: (...args: string[]) => string;
+    media: (...args: string[]) => string;
+  };
+  constructor();
+  reset: () => void;
+  add: (prop: string, value: unknown) => void;
+  remove: (prop: string, value: unknown) => void;
+  merge: (prop: string, value: unknown) => void;
+  update: (prop: string, val: unknown) => void;
+  has: (prop: string) => boolean;
+  contains: (coll: string, value: unknown) => boolean;
+  find: (coll: string, pred: any) => unknown;
+  indexOf: (coll: string, pred: any) => number;
+  loadConfig: () => void;
+  loadMetadata: () => void;
+  loadMedia: () => void;
+  loadTheme: () => void;
+  loadAudioVideo: () => void;
+  loadBuildSettings: (type: string) => BuildSettings | undefined;
+  loadBuilds: () => void;
+}
+declare const _default$1: State;
+//#endregion
+//#region src/Template.d.ts
+declare class Template {
+  static render: (contents: string, template: string) => string;
+}
+//#endregion
+//#region src/Theme.d.ts
+declare class Theme {
+  static list: () => void;
+  static set: (name: string, force?: boolean) => Promise<unknown>;
+}
+//#endregion
+//#region src/Url.d.ts
+declare class Url {
+  static trimSlashes(url: string): string;
+  static removeTrailingSlash: (str: string) => string;
+  static addTrailingSlash: (str: string) => string;
+  static ensureDecoded(str: string): string;
+  static encodeQueryString(url: string): string;
+}
+declare namespace index_d_exports {
+  export { createUnsupportedInline, ensure, ensurePoster, ensureSource, ensureSupportedClassNames, fail, fileId, generateWebpubManifest, getBookMetadata, getImageOrientation, getMediaType, getTitle, opsPath, renderCaption, renderPosterImage, resolveIntersectingUrl, safeWrite, validatePosterImage };
+}
+interface EnsureOptions {
+  files?: Array<{
+    absolutePath: string;
+    content: string;
+  }>;
+  dirs?: string[];
+  prefix?: string;
+}
+interface UnsupportedInlineOptions {
+  id: string;
+  commentStart: string;
+  commentEnd: string;
+  attrString: string;
+  mediaType: string;
+  poster: string;
+}
+declare const opsPath: (fpath: string, base: string) => string;
+declare const fileId: (str: string) => string;
+declare const getImageOrientation: (w: number, h: number) => string | null;
+declare const getTitle: (page: any) => string;
+declare const getBookMetadata: (term: string) => string;
+declare const safeWrite: (dest: string, data: string) => Promise<void>;
+declare const fail: (_msg: unknown, _err: unknown, yargs: any) => void;
+declare const ensure: ({
+  files,
+  dirs,
+  prefix
+}?: EnsureOptions) => Promise<unknown>;
+declare const resolveIntersectingUrl: (u: string, p: string) => string;
+declare const generateWebpubManifest: (files: string[]) => Record<string, unknown>;
+declare const validatePosterImage: (asset: string, type: string) => string;
+declare const renderPosterImage: (poster: string) => string;
+declare const renderCaption: (caption: string, mediaType: string) => string;
+declare const getMediaType: (type: string) => string;
+declare function createUnsupportedInline({
+  id,
+  commentStart,
+  commentEnd,
+  attrString,
+  mediaType,
+  poster
+}: UnsupportedInlineOptions): string;
+declare function ensureSource(obj: any, type: string, fileName: string, lineNumber: number): void;
+declare function ensurePoster(obj: any, type: string): void;
+declare function ensureSupportedClassNames(obj: any, supported: (build: string) => boolean): void;
+//#endregion
+//#region src/YamlAdaptor.d.ts
+declare class YamlAdaptor {
+  static toYaml(input: unknown): string;
+  static load(file: string): unknown;
+  static dump(str: unknown): string;
+  static parse(str: string): unknown;
+}
+//#endregion
+export { type ConfigOptions, _default as EbookConvert, GuideItem, Html, HtmlToXmlParser as HtmlToXml, ManifestItemProperties, Spine, SpineItem, _default$1 as State, Template, Theme, Url, YamlAdaptor, index_d_exports as utils };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/Config.ts","../src/EbookConvert.ts","../src/GuideItem.ts","../src/Html.ts","../src/HtmlToXml.ts","../src/ManifestItemProperties.ts","../src/SpineItem.ts","../src/Spine.ts","../src/Yaml.ts","../src/State.ts","../src/Template.ts","../src/Theme.ts","../src/Url.ts","../src/utils/index.ts","../src/YamlAdaptor.ts"],"mappings":";;;;;UAKiB,aAAA;EACf,GAAA;EACA,GAAA;EACA,IAAA;EACA,KAAA;EACA,sBAAA;EACA,KAAA;EACA,gBAAA;EACA,QAAA;EACA,SAAA;EACA,UAAA;EACA,UAAA;EACA,SAAA;EACA,UAAA,EAAY,MAAA;EACZ,OAAA;EACA,MAAA;EACA,oBAAA,EAAsB,MAAM;EAC5B,MAAA;EACA,eAAA;EAAA,CACC,GAAA;AAAA;;;UCjBO,cAAA;EACR,SAAA;EACA,UAAA;EACA,QAAA;EACA,QAAA;EACA,KAAA;EACA,QAAA;AAAA;AAAA,iBAiDO,OAAA,CAAQ,OAAA,EAAS,cAAA,GAAiB,OAAO;AAAA,cAAA,QAAA;;;;;cC9D5C,SAAA;EACJ,QAAA;EACA,KAAA;EACA,IAAA;;IAGE,QAAA;IACA,KAAA;IACA;EAAA;IACG,QAAA;IAAkB,KAAA;IAAe,IAAA;EAAA;AAAA;;;cCTlC,IAAA;EAAA,OACG,OAAA,CAAQ,GAAA;EAAA,OAIR,MAAA,CAAO,GAAA;AAAA;;;UCDN,sBAAA;EACR,OAAA;EACA,aAAA,GAAgB,MAAA;AAAA;AAAA,cAGZ,eAAA;EACJ,kBAAA,EAAoB,MAAA;EACpB,kBAAA,EAAoB,MAAA;EACpB,qBAAA,EAAuB,MAAA;EACvB,mBAAA,EAAqB,MAAA;EACrB,kBAAA,EAAoB,MAAA;EACpB,qBAAA,EAAuB,MAAA,SAAe,MAAA;EACtC,4BAAA,EAA8B,MAAA,SAE5B,MAAA,UAAgB,KAAA;EAElB,OAAA;EACA,aAAA,GAAgB,MAAA;EAChB,MAAA;EACA,OAAA;;IAEc,OAAA;IAAS;EAAA,GAAiB,sBAAA;EAsIxC,cAAA;EAIA,mBAAA;EAIA,eAAA,CAAgB,IAAA,UAAc,SAAA;EAK9B,uBAAA,CACE,IAAA,UACA,SAAA,UACA,KAAA;EAYF,YAAA,CAAa,IAAA,UAAc,UAAA,GAAY,MAAA;EA6BvC,aAAA,CAAc,IAAA;EAKd,MAAA,CAAO,IAAA;EAIP,SAAA;EAIA,MAAA;EAKA,SAAA,CAAU,IAAA,UAAc,UAAA,GAAY,MAAA;EAmCpC,MAAA,CAAO,IAAA;EASP,UAAA;EAKA,KAAA;EAKA,KAAA;AAAA;;;UC5RQ,YAAA;EACR,YAAA;EACA,IAAI;AAAA;AAAA,UAGI,WAAA;EACR,IAAA;EAAA,CACC,GAAW;AAAA;AAAA,cAIR,sBAAA;EAAA,OACG,aAAA;EAAA,OAGA,MAAA,CAAO,IAAA,EAAM,YAAA;EAAA,OAOb,KAAA,CAAM,IAAA,EAAM,YAAA;EAAA,OAKZ,UAAA,CAAW,IAAA,EAAM,YAAA;EAAA,OAejB,KAAA,CAAM,IAAA,EAAM,YAAA;EAAA,OAOZ,WAAA,CAAY,IAAA,EAAM,WAAA;EAAA,OAOlB,QAAA,CAAS,IAAA,EAAM,WAAA;EAAA,OAOf,kBAAA,CAAmB,IAAA,EAAM,YAAA;EAAA,OAQzB,QAAA,CAAS,IAAA,EAAM,YAAA;EAAA,OAaf,QAAA,CAAS,IAAA,EAAM,WAAA;IAAgB,IAAA;IAAe,OAAA;EAAA;AAAA;;;UCnF7C,gBAAA;EACR,QAAA;EACA,MAAA;EACA,MAAA;EACA,SAAA;EACA,SAAA;EACA,SAAA;EACA,KAAA,GAAQ,SAAS;EACjB,GAAA;EACA,KAAA;AAAA;AAAA,cAGI,SAAA;EACJ,QAAA;EACA,SAAA;EACA,MAAA;EACA,MAAA;EACA,SAAA;EACA,KAAA,EAAO,SAAA;EACP,GAAA;EACA,KAAA;EACA,YAAA;EACA,YAAA;EACA,SAAA;EACA,IAAA;EACA,UAAA;EACA,IAAA;EAAA,OAEO,oBAAA,CAAqB,QAAA;;IAK1B,QAAA;IACA,MAAA;IACA,MAAA;IACA,SAAA;IACA,SAAA;IACA,SAAA;IACA,KAAA;IACA,GAAA;IACA;EAAA,GACC,gBAAA;AAAA;;;UCzCK,YAAA;EACR,GAAA;EACA,SAAA;EACA,oBAAA;AAAA;AAAA,cAGI,KAAA;EACJ,GAAA;EACA,SAAA;EACA,WAAA,EAAa,GAAA,SAAY,MAAA;EACzB,oBAAA;EAEA,OAAA;EACA,MAAA,EAAQ,SAAA;EACR,SAAA,EAAW,IAAA,CAAK,SAAA;;IAEF,GAAA;IAAK,SAAA;IAAW;EAAA,GAAwB,YAAA;EAYtD,KAAA,CAAM,OAAA,WAAsB,SAAA;EA4C5B,YAAA,CAAa,GAAA,EAAK,SAAA,KAAc,IAAA,CAAK,SAAA;EAWrC,WAAA,CAAY,IAAA;EAcZ,MAAA;AAAA;;;cChCI,IAAA;EAEJ,IAAA,EAAM,YAAA,QAAoB,IAAA;EAC1B,MAAA;EACA,MAAA;cAEY,MAAA,UAAgB,MAAA;EAM5B,IAAA,GAAQ,IAAA;EAMR,GAAA,GAAO,KAAA;EAKP,MAAA,GAAU,GAAA,UAAa,KAAA;EAQvB,MAAA,GACE,GAAA,UACA,OAAA,WACA,MAAA,EAAQ,MAAA;EAOV,IAAA;EAEA,IAAA;AAAA;;;KC/FG,WAAA;AAAA,KA0CA,aAAA,GAAgB,MAAM;AAAA,cAErB,KAAA;EAAA,WACO,QAAA;IAAc,KAAA;IAAe,QAAA;IAAqB,IAAA;EAAA;EAQ7D,QAAA,EAAU,IAAA;EAEV,KAAA,EAAO,WAAA;EAEP,KAAA;EAEA,KAAA;EAGA,KAAA;EAEA,KAAA;EAEA,QAAA;EAEA,IAAA;EAEA,MAAA,EAAQ,MAAA,SAAe,aAAA;EASvB,MAAA,EAAS,aAAA;EAET,OAAA;EAAA,IAEI,KAAA,IAAS,KAAA;EAAA,IAIT,KAAA,CAAM,GAAA,EAAK,KAAA;EAAA,IAIX,KAAA;EAAA,IAIA,KAAA,CAAM,GAAA;EAAA,IAIN,OAAA;EAAA,IAIA,OAAA,CAAQ,GAAA;EAAA,IAIR,SAAA;EAAA,IAIA,SAAA,CAAU,GAAA;EAAA,IAIV,MAAA;EAAA,IAIA,MAAA,CAAO,GAAA;EAAA,IAIP,GAAA;EAAA,IAIA,GAAA,CAAI,GAAA;EAAA,IAIJ,YAAA;EAAA,IAIA,YAAA,CAAa,GAAA;EAAA,IAIb,GAAA;EAAA,IAIA,GAAA,CAAI,GAAA;EAAA,IAIJ,MAAA;EAAA,IAIA,MAAA,CAAO,GAAA;EAAA,IAIP,OAAA;EAAA,IAOA,OAAA,CAAQ,GAAA;EAAA,IAKR,GAAA;EAAA,IAIA,GAAA,CAAI,GAAA;EAIR,GAAA;;;;;;;;;EAgBA,IAAA;;;;;;;;;;;EAuCA,KAAA;EAKA,GAAA,GAAO,IAAA,UAAc,KAAA;EAkBrB,MAAA,GAAU,IAAA,UAAc,KAAA;EAoBxB,KAAA,GAAS,IAAA,UAAc,KAAA;EAKvB,MAAA,GAAU,IAAA,UAAc,GAAA;EAIxB,GAAA,GAAO,IAAA;EAIP,QAAA,GAAY,IAAA,UAAc,KAAA;EAI1B,IAAA,GAAQ,IAAA,UAAc,IAAA;EAMtB,OAAA,GAAW,IAAA,UAAc,IAAA;EAKzB,UAAA;EAWA,YAAA;EAQA,SAAA;EAWA,SAAA;EAmDA,cAAA;EAcA,iBAAA,GAAqB,IAAA,aAAe,aAAA;EAyCpC,UAAA;AAAA;AAAA,cAQiC,UAAA;;;cC7c7B,QAAA;EAAA,OACG,MAAA,GAAU,QAAA,UAAkB,QAAA;AAAA;;;cC0I/B,KAAA;EAAA,OACG,IAAA;EAAA,OAeA,GAAA,GAAO,IAAA,UAAc,KAAA,eAAgB,OAAO;AAAA;;;cC9J/C,GAAA;EAAA,OACG,WAAA,CAAY,GAAA;EAAA,OAIZ,mBAAA,GAAuB,GAAA;EAAA,OAKvB,gBAAA,GAAoB,GAAA;EAAA,OAKpB,aAAA,CAAc,GAAA;EAAA,OAQd,iBAAA,CAAkB,GAAA;AAAA;AAAA;;;UCbjB,aAAA;EACR,KAAA,GAAQ,KAAK;IAAG,YAAA;IAAsB,OAAA;EAAA;EACtC,IAAA;EACA,MAAA;AAAA;AAAA,UAGQ,wBAAA;EACR,EAAA;EACA,YAAA;EACA,UAAA;EACA,UAAA;EACA,SAAA;EACA,MAAA;AAAA;AAAA,cAIW,OAAA,GAAW,KAAA,UAAe,IAAY;AAAA,cAItC,MAAA,GAAU,GAAW;AAAA,cAIrB,mBAAA,GAAuB,CAAA,UAAW,CAAS;AAAA,cAoB3C,QAAA,GAAY,IAAS;AAAA,cAQrB,eAAA,GAAmB,IAAY;AAAA,cAS/B,SAAA,GAAa,IAAA,UAAc,IAAA,aAAe,OAAO;AAAA,cAIjD,IAAA,GAAQ,IAAA,WAAe,IAAA,WAAe,KAAA;AAAA,cA8CtC,MAAA;EAAU,KAAA;EAAA,IAAA;EAAA;AAAA,IAIpB,aAAA,KAAqB,OAAA;AAAA,cAOX,sBAAA,GAA0B,CAAA,UAAW,CAAS;AAAA,cAyE9C,sBAAA,GACX,KAAA,eACC,MAAM;AAAA,cAwDI,mBAAA,GAAuB,KAAA,UAAe,IAAY;AAAA,cAUlD,iBAAA,GAAqB,MAAc;AAAA,cAGnC,aAAA,GAAiB,OAAA,UAAiB,SAAiB;AAAA,cAGnD,YAAA,GAAgB,IAAY;AAAA,iBASzB,uBAAA;EACd,EAAA;EACA,YAAA;EACA,UAAA;EACA,UAAA;EACA,SAAA;EACA;AAAA,GACC,wBAAA;AAAA,iBAiBa,YAAA,CACd,GAAA,OACA,IAAA,UACA,QAAA,UACA,UAAA;AAAA,iBAUc,YAAA,CAAa,GAAA,OAAU,IAAY;AAAA,iBAUnC,yBAAA,CACd,GAAA,OACA,SAAA,GAAY,KAAA;;;cC9UR,WAAA;EAAA,OACG,MAAA,CAAO,KAAA;EAAA,OAYP,IAAA,CAAK,IAAA;EAAA,OAWL,IAAA,CAAK,GAAA;EAAA,OAML,KAAA,CAAM,GAAA;AAAA"}