@vivliostyle/cli 5.9.0 → 6.1.0

package/schemas/vivliostyle/vivliostyleConfig.schema.json

@@ -0,0 +1,348 @@
+{
+  "definitions": {
+    "entry": {
+      "type": "string",
+      "minLength": 1
+    },
+    "articleEntryObject": {
+      "type": "object",
+      "properties": {
+        "path": { "type": "string" },
+        "title": { "type": "string" },
+        "theme": {
+          "oneOf": [
+            { "$ref": "#/definitions/theme" },
+            { "$ref": "#/definitions/themeObject" },
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  { "$ref": "#/definitions/theme" },
+                  { "$ref": "#/definitions/themeObject" }
+                ]
+              }
+            }
+          ]
+        },
+        "encodingFormat": { "type": "string" },
+        "rel": {
+          "type": ["string", "array"],
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": ["path"],
+      "additionalProperties": false
+    },
+    "browserType": {
+      "type": "string",
+      "enum": ["chromium", "firefox", "webkit"]
+    },
+    "contentsEntryObject": {
+      "type": "object",
+      "properties": {
+        "rel": {
+          "type": "string",
+          "const": "contents"
+        },
+        "title": { "type": "string" },
+        "theme": {
+          "oneOf": [
+            { "$ref": "#/definitions/theme" },
+            { "$ref": "#/definitions/themeObject" },
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  { "$ref": "#/definitions/theme" },
+                  { "$ref": "#/definitions/themeObject" }
+                ]
+              }
+            }
+          ]
+        }
+      },
+      "required": ["rel"],
+      "additionalProperties": false
+    },
+    "entryObject": {
+      "oneOf": [
+        { "$ref": "#/definitions/contentsEntryObject" },
+        { "$ref": "#/definitions/articleEntryObject" }
+      ]
+    },
+    "output": {
+      "type": "string",
+      "minLength": 1
+    },
+    "outputObject": {
+      "type": "object",
+      "properties": {
+        "path": {
+          "description": "Specify output file name or directory [<title>.pdf].",
+          "type": "string"
+        },
+        "format": {
+          "description": "Specify output format.",
+          "type": "string"
+        },
+        "renderMode": {
+          "description": "if docker is set, Vivliostyle try to render PDF on Docker container [local].",
+          "type": "string",
+          "enum": ["local", "docker"]
+        },
+        "preflight": {
+          "description": "Apply the process to generate PDF for printing.",
+          "type": "string",
+          "enum": ["press-ready", "press-ready-local"]
+        },
+        "preflightOption": {
+          "description": "Options for preflight process (ex: gray-scale, enforce-outline). Please refer the document of press-ready for further information. https://github.com/vibranthq/press-ready",
+          "type": "array",
+          "items": { "type": "string" }
+        }
+      },
+      "required": ["path"],
+      "additionalProperties": false
+    },
+    "theme": {
+      "type": "string",
+      "minLength": 1
+    },
+    "themeObject": {
+      "type": "object",
+      "properties": {
+        "specifier": {
+          "description": "Sepcifier name of importing theme package or a path of CSS file. \n- A npm-style package argument is allowed (ex: @vivliostyle/theme-academic@1 ./local-pkg)\n- A URL or a local path of CSS is allowed (ex: ./style.css, https://example.com/style.css)",
+          "type": "string",
+          "minLength": 1
+        },
+        "import": {
+          "description": "Importing CSS path(s) of the package. Specify this if you want to import other than the default file.",
+          "type": ["string", "array"],
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": ["specifier"],
+      "additionalProperties": false
+    },
+    "vfmReplaceRule": {
+      "type": "object",
+      "properties": {
+        "test": {
+          "type": "object",
+          "tsType": "RegExp"
+        },
+        "match": {
+          "instanceOf": "Function",
+          "tsType": "(result: RegExpMatchArray, h: any) => Object | string"
+        }
+      },
+      "required": ["test", "match"],
+      "additionalProperties": false
+    },
+    "vivliostyleConfigEntry": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Title",
+          "minLength": 1
+        },
+        "author": {
+          "type": "string",
+          "description": "Author",
+          "minLength": 1
+        },
+        "theme": {
+          "description": "Theme package path(s) or URL(s) of css file.",
+          "oneOf": [
+            { "$ref": "#/definitions/theme" },
+            { "$ref": "#/definitions/themeObject" },
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  { "$ref": "#/definitions/theme" },
+                  { "$ref": "#/definitions/themeObject" }
+                ]
+              }
+            }
+          ]
+        },
+        "entry": {
+          "description": "Entry file(s) of document.",
+          "oneOf": [
+            { "$ref": "#/definitions/entry" },
+            { "$ref": "#/definitions/articleEntryObject" },
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  { "$ref": "#/definitions/entry" },
+                  { "$ref": "#/definitions/entryObject" }
+                ]
+              },
+              "uniqueItems": true
+            }
+          ]
+        },
+        "entryContext": {
+          "description": "Directory of referencing entry file(s).",
+          "type": "string",
+          "minLength": 1
+        },
+        "output": {
+          "description": "Options about outputs.",
+          "oneOf": [
+            {
+              "type": "array",
+              "items": {
+                "oneOf": [
+                  { "$ref": "#/definitions/output" },
+                  { "$ref": "#/definitions/outputObject" }
+                ]
+              }
+            },
+            { "$ref": "#/definitions/output" },
+            { "$ref": "#/definitions/outputObject" }
+          ]
+        },
+        "workspaceDir": {
+          "type": "string",
+          "description": "",
+          "minLength": 1
+        },
+        "includeAssets": {
+          "oneOf": [
+            {
+              "type": "array",
+              "items": { "$ref": "#/definitions/entry" }
+            },
+            { "$ref": "#/definitions/entry" }
+          ]
+        },
+        "size": {
+          "description": "Output pdf size [Letter]. preset: A5, A4, A3, B5, B4, JIS-B5, JIS-B4, letter, legal, ledger. custom(comma separated): 182mm,257mm or 8.5in,11in.",
+          "type": "string",
+          "minLength": 1
+        },
+        "pressReady": {
+          "description": "Make generated PDF compatible with press ready PDF/X-1a [false]. This option is equivalent with \"preflight\": \"press-ready\"",
+          "type": "boolean"
+        },
+        "language": {
+          "description": "Language",
+          "type": "string",
+          "minLength": 1
+        },
+        "readingProgression": {
+          "type": "string",
+          "enum": ["ltr", "rtl"],
+          "default": "ltr"
+        },
+        "toc": {
+          "oneOf": [
+            { "type": "boolean" },
+            {
+              "type": "string",
+              "minLength": 1
+            }
+          ]
+        },
+        "tocTitle": {
+          "type": "string",
+          "minLength": 1
+        },
+        "cover": {
+          "type": "string",
+          "minLength": 1
+        },
+        "timeout": {
+          "description": "Timeout limit for waiting Vivliostyle process [120000]",
+          "type": "number",
+          "minimum": 0
+        },
+        "vfm": {
+          "description": "Option for convert Markdown to a stringify (HTML).",
+          "type": "object",
+          "properties": {
+            "style": {
+              "description": "Custom stylesheet path/URL.",
+              "type": ["string", "array"],
+              "items": {
+                "type": "string"
+              }
+            },
+            "partial": {
+              "description": "Output markdown fragments.",
+              "type": "boolean"
+            },
+            "title": {
+              "description": "Document title (ignored in partial mode).",
+              "type": "string"
+            },
+            "language": {
+              "description": "Document language (ignored in partial mode).",
+              "type": "string"
+            },
+            "replace": {
+              "description": "Replacement handler for HTML string.",
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/vfmReplaceRule"
+              }
+            },
+            "hardLineBreaks": {
+              "description": "Add `<br>` at the position of hard line breaks, without needing spaces.",
+              "type": "boolean"
+            },
+            "disableFormatHtml": {
+              "description": "Disable automatic HTML format.",
+              "type": "boolean"
+            },
+            "math": {
+              "description": "Enable math syntax.",
+              "type": "boolean"
+            }
+          }
+        },
+        "image": {
+          "description": "Specify a docker image to render.",
+          "type": "string",
+          "minLength": 1
+        },
+        "http": {
+          "description": "Launch an HTTP server hosting contents instead of file protocol. It is useful that requires CORS such as external web fonts.",
+          "type": "boolean"
+        },
+        "viewer": {
+          "description": "Specify a URL of displaying viewer instead of vivliostyle-cli's one. It is useful that using own viewer that has staging features. (ex: https://vivliostyle.vercel.app/)",
+          "type": "string",
+          "minLength": 1
+        },
+        "browser": {
+          "description": "EXPERIMENTAL SUPPORT: Specify a browser type to launch Vivliostyle viewer. Currently, Firefox and Webkit support preview command only!",
+          "oneOf": [{ "$ref": "#/definitions/browserType" }],
+          "default": "chromium"
+        }
+      },
+      "required": ["entry"]
+    }
+  },
+  "oneOf": [
+    {
+      "$ref": "#/definitions/vivliostyleConfigEntry"
+    },
+    {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/vivliostyleConfigEntry"
+      },
+      "minItems": 1
+    }
+  ]
+}

package/types/better-ajv-errors.d.ts

@@ -0,0 +1,28 @@
+// Type file providing better-ajv-errors package seems not to be loaded
+// because newer TypeScript doesn't look "types" settings in `type: module` context.
+declare module 'better-ajv-errors' {
+  import type { ErrorObject } from 'ajv';
+
+  export interface IOutputError {
+    start: { line: number; column: number; offset: number };
+    // Optional for required
+    end?: { line: number; column: number; offset: number };
+    error: string;
+    suggestion?: string;
+  }
+
+  export interface IInputOptions {
+    format?: 'cli' | 'js';
+    indent?: number | null;
+
+    /** Raw JSON used when highlighting error location */
+    json?: string | null;
+  }
+
+  export default function <S, T, Options extends IInputOptions>(
+    schema: S,
+    data: T,
+    errors: Array<ErrorObject>,
+    options?: Options,
+  ): Options extends { format: 'js' } ? Array<IOutputError> : string;
+}

package/types/custom.d.ts

@@ -0,0 +1,9 @@
+declare module 'hastscript';
+
+declare type Without<T> = { [P in keyof T]?: never };
+type Tail<T extends any[]> = T extends [any, ...infer XS] ? XS : never;
+type Union<T extends any[]> = T extends [] ? {} : T[0] & Union<Tail<T>>;
+declare type XOR<T extends any[], U extends any[] = []> = T extends []
+  ? never
+  : (T[0] & Without<Union<[...U, ...Tail<T>]>>) | XOR<Tail<T>, [T[0], ...U]>;
+declare type Resolved<T> = T extends Promise<infer U> ? U : never;

package/types/playwright.d.ts

@@ -0,0 +1,49 @@
+declare module 'playwright-core/lib/server' {
+  export type BrowserName = 'chromium' | 'firefox' | 'webkit';
+  type InternalTool =
+    | 'ffmpeg'
+    | 'firefox-beta'
+    | 'chromium-with-symbols'
+    | 'chromium-tip-of-tree';
+  type ChromiumChannel =
+    | 'chrome'
+    | 'chrome-beta'
+    | 'chrome-dev'
+    | 'chrome-canary'
+    | 'msedge'
+    | 'msedge-beta'
+    | 'msedge-dev'
+    | 'msedge-canary';
+
+  export interface Executable {
+    type: 'browser' | 'tool' | 'channel';
+    name: BrowserName | InternalTool | ChromiumChannel;
+    browserName: BrowserName | undefined;
+    installType:
+      | 'download-by-default'
+      | 'download-on-demand'
+      | 'install-script'
+      | 'none';
+    directory: string | undefined;
+    executablePathOrDie(sdkLanguage?: string): string;
+    executablePath(sdkLanguage?: string): string | undefined;
+    validateHostRequirements(sdkLanguage: string): Promise<void>;
+  }
+
+  class Registry {
+    executables(): Executable[];
+    findExecutable(name: BrowserName): Executable;
+    findExecutable(name: string): Executable | undefined;
+    defaultExecutables(): Executable[];
+    installDeps(
+      executablesToInstallDeps: Executable[],
+      dryRun: boolean,
+    ): Promise<void>;
+    install(
+      executablesToInstall: Executable[],
+      forceReinstall: boolean,
+    ): Promise<void>;
+  }
+
+  export const registry: Registry;
+}

package/dist/schema/pubManifest/module/ItemList.schema.json

@@ -1,32 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/ItemList.schema.json",
-    "title": "schema.org ItemList object",
-    "type": "object",
-    "properties": {
-        "type": {
-            "oneOf": [
-                {
-                    "type": "string",
-                    "const": "ItemList"
-                },
-                {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    },
-                    "contains": {
-                        "const": "ItemList"
-                    }
-                }
-            ]
-        },
-        "itemListElement": {
-            "type": ["array"],
-            "items": {
-                "type": "string"
-            }
-        }
-    },
-    "required": ["type", "itemListElement"]
-}

package/dist/schema/pubManifest/module/bcp.schema.json

@@ -1,7 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/bcp.schema.json",
-    "title": "BCP47 Language tag",
-    "type": "string",
-    "pattern": "^((?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?:([A-Za-z]{2,3}(-(?:[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?:[A-Za-z]{4}))?(-(?:[A-Za-z]{2}|[0-9]{3}))?(-(?:[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?:[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?:x(-[A-Za-z0-9]{1,8})+))?)|(?:x(-[A-Za-z0-9]{1,8})+))$"
-}

package/dist/schema/pubManifest/module/context.schema.json

@@ -1,62 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/context.schema.json",
-    "title": "Publication Contexts",
-    "type": "array",
-    "items": [
-        {
-            "const": "https://schema.org"
-        },
-        {
-            "const": "https://www.w3.org/ns/pub-context"
-        }
-    ],
-    "additionalItems": {
-        "anyOf": [
-            {
-                "type": "string"
-            },
-            {
-                "type": "object",
-                "properties": {
-                    "language": {
-                        "$ref": "bcp.schema.json"
-                    },
-                    "direction": false
-                },
-                "required": ["language"]
-            },
-            {
-                "type": "object",
-                "properties": {
-                    "direction": {
-                        "type": "string",
-                        "enum": ["ltr", "rtl"]
-                    },
-                    "language": false
-                },
-                "required": ["direction"]
-            },
-            {
-                "type": "object",
-                "properties": {
-                    "language": {
-                        "$ref": "bcp.schema.json"
-                    },
-                    "direction": {
-                        "type": "string",
-                        "enum": ["ltr", "rtl"]
-                    }
-                },
-                "required": ["language", "direction"]
-            },
-            {
-                "type": "object",
-                "properties": {
-                    "language": false,
-                    "direction": false
-                }
-            }
-        ]
-    }
-}

package/dist/schema/pubManifest/module/contributor-object.schema.json

@@ -1,42 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/contributor-object.schema.json",
-    "title": "Contributor Object",
-    "type": "object",
-    "properties": {
-        "name": {
-            "$ref": "localizable.schema.json"
-        },
-        "id": {
-            "$ref": "url.schema.json"
-        },
-        "type": {
-            "oneOf": [
-                {
-                    "type": "string",
-                    "enum": ["Person", "Organization"],
-                    "default": "Person"
-                },
-                {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    },
-                    "contains": {
-                        "enum": ["Person", "Organization"]
-                    }
-                }
-            ]
-        },
-        "url": {
-            "$ref": "url.schema.json"
-        },
-        "identifier": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            }
-        }
-    },
-    "required": ["name"]
-}

package/dist/schema/pubManifest/module/contributor.schema.json

@@ -1,26 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/contributor.schema.json",
-    "title": "Contributor",
-    "anyOf": [
-        {
-            "type": "string"
-        },
-        {
-            "type": "array",
-            "items": {
-                "anyOf": [
-                    {
-                        "type": "string"
-                    },
-                    {
-                        "$ref": "contributor-object.schema.json"
-                    }
-                ]
-            }
-        },
-        {
-            "$ref": "contributor-object.schema.json"
-        }
-    ]
-}

package/dist/schema/pubManifest/module/date.schema.json

@@ -1,7 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/date.schema.json",
-    "title": "Dates",
-    "type": "string",
-    "format": "date-time"
-}

package/dist/schema/pubManifest/module/duration.schema.json

@@ -1,7 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/duration.schema.json",
-    "title": "Duration",
-    "type": "string",
-    "pattern": "^P(?!$)((\\d+Y)|(\\d+\\.\\d+Y$))?((\\d+M)|(\\d+\\.\\d+M$))?((\\d+W)|(\\d+\\.\\d+W$))?((\\d+D)|(\\d+\\.\\d+D$))?(T(?=\\d)((\\d+H)|(\\d+\\.\\d+H$))?((\\d+M)|(\\d+\\.\\d+M$))?(\\d+(\\.\\d+)?S)?)??$"
-}

package/dist/schema/pubManifest/module/item-lists.schema.json

@@ -1,16 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/item-lists.schema.json",
-    "title": "Lists of ItemList",
-    "oneOf": [
-        {
-            "$ref": "ItemList.schema.json"
-        },
-        {
-            "type": "array",
-            "items": {
-                "$ref": "ItemList.schema.json"
-            }
-        }
-    ]
-}

package/dist/schema/pubManifest/module/language.schema.json

@@ -1,16 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$id": "https://www.w3.org/ns/pub-schema/manifest/module/language.schema.json",
-    "title": "Languages",
-    "oneOf": [
-        {
-            "$ref": "bcp.schema.json"
-        },
-        {
-            "type": "array",
-            "items": {
-                "$ref": "bcp.schema.json"
-            }
-        }
-    ]
-}