@canopycanopycanopy/b-ber-tasks 3.0.8-nav-memo.2 → 3.0.8-next.100

package/README.md

@@ -1,9 +1,39 @@
 # `@canopycanopycanopy/b-ber-tasks`
 
-The `b-ber-tasks` package contains modules used for b-ber's I/O operations.
+`b-ber-tasks` defines every individual build step in the b-ber pipeline. Each task is an async function (Promise-based) that reads from and writes to the shared `State` object in `b-ber-lib`. `b-ber-cli` composes these tasks into ordered sequences to produce EPUB, Mobi, PDF, web, reader, and XML builds. The package also includes tasks for serving the output locally via browser-sync, deploying to remote hosts, and generating the full-text Lunr search index.
 
-## Install
+## Key exports
 
-```
-$ npm i -g @canopycanopycanopy/b-ber-tasks
+| Export      | Purpose                                                    |
+| ----------- | ---------------------------------------------------------- |
+| `render`    | Converts Markdown source files to XHTML pages              |
+| `opf`       | Generates the EPUB OPF (manifest, metadata, spine, guide)  |
+| `container` | Creates the EPUB `META-INF/container.xml`                  |
+| `epub`      | Zips the OPS directory into a `.epub` archive              |
+| `sass`      | Compiles SCSS to CSS with autoprefixer                     |
+| `scripts`   | Bundles and minifies JavaScript assets                     |
+| `copy`      | Copies static assets (images, fonts, media) into the build |
+| `cover`     | Generates the EPUB cover image entry                       |
+| `footnotes` | Collects and renders footnote pages                        |
+| `loi`       | Generates the List of Illustrations page                   |
+| `generate`  | Generates placeholder XHTML files for non-Markdown content |
+| `inject`    | Injects navigation and UI elements into rendered HTML      |
+| `init`      | Scaffolds a new b-ber project directory                    |
+| `clean`     | Removes build output directories                           |
+| `mobi`      | Runs Calibre conversion to produce `.mobi`                 |
+| `pdf`       | Produces PDF output                                        |
+| `web`       | Builds the static website output                           |
+| `reader`    | Builds the reader-compatible output                        |
+| `xml`       | Builds the InDesign XML output                             |
+| `sample`    | Builds the sample (excerpt) output                         |
+| `serve`     | Starts a browser-sync dev server                           |
+| `deploy`    | Deploys build output to a remote host                      |
+| `validate`  | Validates directive syntax in Markdown source              |
+| `serialize` | Serialises the spine/TOC data structure                    |
+
+## Dev
+
+```bash
+npm test      # jest
+npm run build
 ```

package/dist/index.d.ts

@@ -0,0 +1,144 @@
+//#region src/clean/index.d.ts
+declare const _default: () => Promise<void>;
+//#endregion
+//#region src/container/index.d.ts
+declare const _default$1: () => Promise<void | void[]>;
+//#endregion
+//#region src/copy/index.d.ts
+declare const copy: () => Promise<void | void[]>;
+//#endregion
+//#region src/cover/index.d.ts
+declare const _default$2: () => Promise<void>;
+//#endregion
+//#region src/deploy/index.d.ts
+declare function main({
+  builds,
+  yes
+}: {
+  builds?: string[];
+  yes?: boolean;
+}): Promise<void>;
+//#endregion
+//#region src/epub/index.d.ts
+declare const epub: () => any;
+//#endregion
+//#region src/footnotes/index.d.ts
+declare const _default$3: () => Promise<any>;
+//#endregion
+//#region src/generate/index.d.ts
+declare const generate: (metadata: Record<string, string>) => Promise<void>;
+//#endregion
+//#region src/init/index.d.ts
+declare class Initializer {
+  src: string;
+  dist: string;
+  name: string;
+  config: Record<string, any>;
+  path: string;
+  builds: string[];
+  constructor({
+    name,
+    config
+  }?: {
+    name?: string;
+    config?: Record<string, any>;
+  });
+  createAssets: () => any;
+  copyImages(): Promise<void[]>;
+  setTheme(): any;
+  start(): void;
+}
+//#endregion
+//#region src/inject/index.d.ts
+declare const inject: () => Promise<void | void[]>;
+//#endregion
+//#region src/loi/index.d.ts
+declare const loi: () => Promise<any>;
+//#endregion
+//#region src/mobi/index.d.ts
+declare const mobi: () => any;
+//#endregion
+//#region src/mobi/mobi-css.d.ts
+declare const mobiCSS: () => Promise<void | void[]>;
+//#endregion
+//#region src/opf/Opf.d.ts
+declare class Opf {
+  static createOpf(): Promise<void>;
+  static writeOPF(contents: string): Promise<void>;
+  static createOpfPackageString([manifestAndMetadataXML, navigationXML]: [any, any]): any;
+}
+//#endregion
+//#region src/opf/index.d.ts
+declare const opf: typeof Opf.createOpf;
+//#endregion
+//#region src/pdf/index.d.ts
+declare const pdf: () => Promise<any>;
+//#endregion
+//#region src/reader/index.d.ts
+declare class Reader {
+  outputDirName: string;
+  outputDir: string;
+  apiDir: string;
+  epubAssets: string[];
+  readerModuleName: string;
+  readerModuleDistDir: string;
+  readerAppPath: string | null;
+  constructor();
+  get remoteURL(): any;
+  createDirname(s: string): string;
+  ensureReaderModuleExists(): void;
+  createOutputDirs(): Promise<void>;
+  copyEpubToOutputDir(): Promise<void[]>;
+  getBookMetadata(term?: any): any;
+  getProjectConfig(term?: string): any;
+  writeBookManifest(): Promise<void>;
+  writeWebpubManifest(): Promise<void>;
+  injectWebpubManifestLink(): Promise<void>;
+  copyReaderAppToOutputDir(): Promise<void[]>;
+  injectServerDataIntoTemplate(): Promise<void>;
+  updateLinkedResourcesWithAbsolutePaths(): Promise<void>;
+  updateAssetURLsWithAbsolutePaths(): Promise<void>;
+}
+declare const main$1: () => Reader;
+//#endregion
+//#region src/render/index.d.ts
+declare function render(): Promise<void>;
+//#endregion
+//#region src/sample/index.d.ts
+declare const sample: () => Promise<void>;
+//#endregion
+//#region src/sass/index.d.ts
+declare const sass: () => Promise<void>;
+//#endregion
+//#region src/scripts/index.d.ts
+declare const scripts: () => Promise<void>;
+//#endregion
+//#region src/serialize.d.ts
+type TaskFn = (resp?: unknown) => Promise<unknown>;
+type TaskEntry = string | TaskFn;
+declare const serialize: (sequence: TaskEntry[]) => Promise<unknown>;
+//#endregion
+//#region src/serve/index.d.ts
+declare const serve: ({
+  build: buildOption,
+  external
+}: {
+  build?: string;
+  external?: boolean;
+}) => Promise<void>;
+//#endregion
+//#region src/validate/index.d.ts
+declare const validate: ({
+  project
+}: {
+  project: string;
+}) => Promise<void>;
+//#endregion
+//#region src/web/index.d.ts
+declare const web: () => Promise<void>;
+//#endregion
+//#region src/xml/index.d.ts
+declare const xml: () => Promise<void>;
+//#endregion
+export { _default as clean, _default$1 as container, copy, _default$2 as cover, main as deploy, epub, _default$3 as footnotes, generate, Initializer as init, inject, loi, mobi, mobiCSS, opf, pdf, main$1 as reader, render, sample, sass, scripts, serialize, serve, validate, web, xml };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/clean/index.ts","../src/container/index.ts","../src/copy/index.ts","../src/cover/index.ts","../src/deploy/index.ts","../src/epub/index.ts","../src/footnotes/index.ts","../src/generate/index.ts","../src/init/index.ts","../src/inject/index.ts","../src/loi/index.ts","../src/mobi/index.ts","../src/mobi/mobi-css.ts","../src/opf/Opf.ts","../src/opf/index.ts","../src/pdf/index.ts","../src/reader/index.ts","../src/render/index.ts","../src/sample/index.ts","../src/sass/index.ts","../src/scripts/index.ts","../src/serialize.ts","../src/serve/index.ts","../src/validate/index.ts","../src/web/index.ts","../src/xml/index.ts"],"mappings":";;;;;;;cEUM,IAAA,QAAI,OAAA;;;;;;iBE8MD,IAAA;EAAO,MAAA;EAAQ;AAAA;EAAS,MAAA;EAAmB,GAAA;AAAA,IAAe,OAAA;;;cCnN7D,IAAA;;;;;;cEwEA,QAAA,GAAQ,QAAA,EAZG,MAAA,qBAAsB,OAAA;;;cCvDjC,WAAA;EACJ,GAAA;EACA,IAAA;EACA,IAAA;EACA,MAAA,EAAS,MAAA;EACT,IAAA;EACA,MAAA;;IAGE,IAAA;IACA;EAAA;IACG,IAAA;IAAe,MAAA,GAAS,MAAA;EAAA;EAa7B,YAAA;EAiBA,UAAA,IAAU,OAAA;EAkBV,QAAA;EAOA,KAAA;AAAA;;;cC4DI,MAAA,QAAM,OAAA;;;cCzCN,GAAA,QAAG,OAAA;;;cC9EH,IAAA;;;cCmEA,OAAA,QAAO,OAAA;;;cCzEP,GAAA;EAAA,OACG,SAAA,IAAS,OAAA;EAAA,OAST,QAAA,CAAS,QAAA,WAAgB,OAAA;EAAA,OAQzB,sBAAA,EAAwB,sBAAA,EAAwB,aAAA;AAAA;;;cCzBnD,GAAA,SAAG,GAAA,CAAA,SAAgB;;;cCoInB,GAAA,QAAG,OAAA;;;cC1HH,MAAA;EACJ,aAAA;EACA,SAAA;EACA,MAAA;EACA,UAAA;EACA,gBAAA;EACA,mBAAA;EACA,aAAA;;MA6BI,SAAA;EAcJ,aAAA,CAAc,CAAA;EAOd,wBAAA;EAiDA,gBAAA,IAAgB,OAAA;EAIhB,mBAAA,IAAmB,OAAA;EASnB,eAAA,CAAgB,IAAA;EAWhB,gBAAA,CAAiB,IAAA;EAUjB,iBAAA,IAAiB,OAAA;EAoBjB,mBAAA,IAAmB,OAAA;EAanB,wBAAA,IAAwB,OAAA;EAgBxB,wBAAA,IAAwB,OAAA;EAaxB,4BAAA,IAA4B,OAAA;EAwC5B,sCAAA,IAAsC,OAAA;EAgBtC,gCAAA,IAAgC,OAAA;AAAA;AAAA,cAiB5B,MAAA,QAAI,MAAqB;;;iBCjQtB,MAAA,IAAM,OAAA;;;cChCT,MAAA,QAAM,OAAA;;;cCqMN,IAAA,QAAI,OAAA;;;cChIJ,OAAA,QAAO,OAAA;;;KCjDR,MAAA,IAAU,IAAA,eAAmB,OAAO;AAAA,KACpC,SAAA,YAAqB,MAAM;AAAA,cAgC1B,SAAA,GAAa,QAAA,EAAU,SAAA,OAAW,OAAA;;;cCsBlC,KAAA;EAAe,KAAA,EAAA,WAAA;EAAA;AAAA;EAInB,KAAA;EACA,QAAA;AAAA,MACD,OAAA;;;cC3EK,QAAA;EAAkB;AAAA;EAAe,OAAA;AAAA,MAAiB,OAAA;;;cC6ZlD,GAAA,QAAG,OAAA;;;cC3XH,GAAA,QAAG,OAAA"}