@cenk1cenk2/md-printer 3.2.24 → 3.4.0

package/dist/services/template/template.schema.mjs

@@ -0,0 +1,27 @@
+import { TemplateSourceType } from "../../constants/template.constants.mjs";
+import { z } from "zod";
+const TemplateSourceSchema = z.discriminatedUnion("type", [
+	z.strictObject({
+		type: z.literal("builtin"),
+		name: z.string().regex(/^[^\\/]+$/, "Built-in template names have no path separator.")
+	}),
+	z.strictObject({
+		type: z.literal("package"),
+		name: z.string().regex(/^(@[a-z0-9-~][a-z0-9-._~]*\/)?[a-z0-9-~][a-z0-9-._~]*$/, "Not an npm package name."),
+		directory: z.string().optional()
+	}),
+	z.strictObject({
+		type: z.literal("directory"),
+		path: z.string().min(1)
+	})
+], { error: () => `Use a string or an object with a type of ${Object.values(TemplateSourceType).join(", ")}.` });
+const TemplateSettingsSchema = z.looseObject({ files: z.strictObject({
+	template: z.string().min(1).optional(),
+	components: z.union([z.string().min(1), z.array(z.string().min(1)).min(1)]).optional(),
+	extension: z.union([z.string().min(1), z.array(z.string().min(1)).min(1)]).optional(),
+	i18n: z.union([z.string().min(1), z.array(z.string().min(1)).min(1)]).optional()
+}).optional() });
+function issues({ issues }) {
+	return issues.map(({ path, message }) => [...path, message].join(": ")).join(", ");
+}
+export { TemplateSettingsSchema, TemplateSourceSchema, issues };

package/dist/services/template/template.service.mjs

@@ -1,12 +1,13 @@
-import { inlineCss, inlineHtml } from "./assets.mjs";
+import { inlineCss, inlineHtml, resolveConfined } from "./assets.mjs";
 import { sveltePlugin } from "./svelte.plugin.mjs";
-import "../../constants/template.constants.mjs";
-import __decorateMetadata from "../../_virtual/_@oxc-project_runtime@0.156.0/helpers/esm/decorateMetadata.mjs";
-import __decorate from "../../_virtual/_@oxc-project_runtime@0.156.0/helpers/esm/decorate.mjs";
+import { TemplateSettingsSchema, issues } from "./template.schema.mjs";
+import { TEMPLATE_EXTENSION_FILES, TEMPLATE_LAYOUT, TEMPLATE_PACKAGE_PREFIX } from "../../constants/template.constants.mjs";
+import __decorateMetadata from "../../_virtual/_@oxc-project_runtime@0.157.0/helpers/esm/decorateMetadata.mjs";
+import __decorate from "../../_virtual/_@oxc-project_runtime@0.157.0/helpers/esm/decorate.mjs";
 import { Injectable } from "@nestjs/common";
-import { dirname, isAbsolute, join, resolve } from "path";
+import { dirname, isAbsolute, join, relative, resolve, sep } from "path";
 import { FileSystemService } from "@cenk1cenk2/oclif-common";
-import { fileURLToPath } from "url";
+import { fileURLToPath, pathToFileURL } from "url";
 import { homedir } from "os";
 import { compile } from "@tailwindcss/node";
 import { Scanner } from "@tailwindcss/oxide";
@@ -45,21 +46,20 @@ let TemplateService = class TemplateService {
 	constructor(fs) {
 		this.fs = fs;
 	}
-	resolve(template) {
-		const path = template.replace(/^~(?=\/|$)/, homedir());
-		const directory = isAbsolute(path) || path.startsWith(".") || /[\\/]/.test(path) ? resolve(path) : join(_TemplateService.ROOT, "templates", path);
-		if (!this.fs.exists(join(directory, "Template.svelte"))) throw new Error(`Template does not exist, expected Template.svelte in: ${directory}`);
-		return directory;
-	}
-	async settings(directory) {
-		const file = join(directory, "settings.json");
-		if (!this.fs.exists(file)) return {};
-		return JSON.parse(await this.fs.read(file));
+	async resolve(template, base) {
+		const directory = await this.locate(template, base);
+		const settings = await this.settings(directory);
+		return {
+			directory,
+			settings,
+			files: await this.paths(directory, settings.files)
+		};
 	}
-	async bundle(directory) {
+	async bundle(files) {
 		const stylesheets = [];
-		const { module: entry, modules } = await this.compile(_TemplateService.ENTRY, join(directory, "Template.svelte"), stylesheets);
+		const { module: entry, modules } = await this.compile(_TemplateService.ENTRY, stylesheets, files);
 		return {
+			template: files.template,
 			entry,
 			modules,
 			stylesheets,
@@ -67,17 +67,22 @@ let TemplateService = class TemplateService {
 		};
 	}
 	async page(file) {
-		const { module } = await this.compile(file, file, []);
+		const { module } = await this.compile(file, [], {
+			directory: dirname(file),
+			template: file
+		});
 		return `<!doctype html>${render(module.default).body}`;
 	}
 	async render(directory, bundle, document, markdown, options) {
 		const context = [
 			["md-printer:document", document],
 			["md-printer:markdown", markdown],
-			["md-printer:components", bundle.entry.components]
+			["md-printer:components", bundle.entry.components],
+			["md-printer:extension", bundle.entry.extension]
 		];
 		const props = {
 			...document,
+			extension: bundle.entry.extension,
 			content: bundle.entry.content(markdown, context)
 		};
 		const [body, header, footer] = await Promise.all([
@@ -108,16 +113,107 @@ let TemplateService = class TemplateService {
 			dependencies
 		};
 	}
-	async compile(input, template, stylesheets) {
+	locate(template, base) {
+		if (typeof template === "string") {
+			const path = this.expand(template);
+			return isAbsolute(path) || path.startsWith(".") || /[\\/]/.test(path) ? resolve(path) : this.builtin(path);
+		}
+		switch (template.type) {
+			case "builtin": return this.builtin(template.name);
+			case "package": return this.package(template, base);
+			case "directory": return resolve(base, this.expand(template.path));
+		}
+	}
+	expand(path) {
+		return path.replace(/^~(?=\/|$)/, homedir());
+	}
+	/** A built-in template is a package of its own, so it brings its own fonts, icons and stylesheets as dependencies. */
+	builtin(name) {
+		const pkg = `${TEMPLATE_PACKAGE_PREFIX}${name}`;
+		try {
+			return dirname(this.require.resolve(`${pkg}/package.json`));
+		} catch {
+			throw new Error(`Template does not exist, expected the built-in template package ${pkg} or a path to a template directory.`);
+		}
+	}
+	async package({ name, directory }, base) {
+		const root = this.installed(name, [.../* @__PURE__ */ new Set([base, process.cwd()]), _TemplateService.ROOT]);
+		if (directory === void 0) return root;
+		const confined = await resolveConfined(resolve(root, directory), root);
+		if (!confined) throw new Error(`Template directory "${directory}" of the package ${name} has to exist inside the package: ${root}`);
+		return confined;
+	}
+	installed(name, roots) {
+		for (const root of roots) try {
+			return dirname(createRequire(join(root, "package.json")).resolve(`${name}/package.json`));
+		} catch {
+			continue;
+		}
+		throw new Error(`Template does not exist, the package ${name} is not installed in any of: ${roots.join(", ")}`);
+	}
+	async settings(directory) {
+		const file = join(directory, "settings.json");
+		if (!this.fs.exists(file)) return {};
+		const { success, data, error } = TemplateSettingsSchema.safeParse(JSON.parse(await this.fs.read(file)));
+		if (!success) throw new Error(`Template settings are invalid in ${file}: ${issues(error)}`);
+		return data;
+	}
+	async paths(directory, files = {}) {
+		const template = files.template ? await this.configured(directory, "template", files.template) : this.first(directory, TEMPLATE_LAYOUT.template);
+		const components = files.components ? await Promise.all([files.components].flat().map((path) => this.configured(directory, "components", path))) : [this.first(directory, TEMPLATE_LAYOUT.components) ?? join(directory, TEMPLATE_LAYOUT.components[0])];
+		const i18n = files.i18n ? await Promise.all([files.i18n].flat().map((path) => this.configured(directory, "i18n", path))) : [this.first(directory, TEMPLATE_LAYOUT.i18n) ?? join(directory, TEMPLATE_LAYOUT.i18n[0])];
+		const extension = files.extension ? await Promise.all([files.extension].flat().map((path) => this.configured(directory, "extension", path))) : [this.extension(directory)].filter((path) => path !== void 0);
+		if (!template) throw new Error(`Template does not exist, expected ${TEMPLATE_LAYOUT.template.join(" or ")} in: ${directory}`);
+		return {
+			directory,
+			template,
+			components,
+			i18n,
+			extension,
+			candidates: [
+				...files.template ? [template] : TEMPLATE_LAYOUT.template.map((path) => join(directory, path)),
+				...files.components ? components : TEMPLATE_LAYOUT.components.map((path) => join(directory, path)),
+				...files.i18n ? i18n : TEMPLATE_LAYOUT.i18n.map((path) => join(directory, path)),
+				...files.extension ? extension : TEMPLATE_LAYOUT.extension.flatMap((path) => TEMPLATE_EXTENSION_FILES.map((file) => join(directory, path, file)))
+			]
+		};
+	}
+	async configured(directory, key, value) {
+		const path = resolve(directory, value);
+		const rel = relative(directory, path);
+		const outside = rel === ".." || rel.startsWith(`..${sep}`) || isAbsolute(rel);
+		if (!outside && !this.fs.exists(path)) throw new Error(`Template settings point files.${key} to a path that does not exist: ${path}`);
+		if (outside || !await resolveConfined(path, directory)) throw new Error(`Template settings point files.${key} outside of the template directory: ${value}`);
+		return path;
+	}
+	first(directory, paths) {
+		return paths.map((path) => join(directory, path)).find((path) => this.fs.exists(path));
+	}
+	extension(directory) {
+		for (const location of TEMPLATE_LAYOUT.extension) {
+			const files = TEMPLATE_EXTENSION_FILES.filter((file) => this.fs.exists(join(directory, location, file)));
+			if (files.length > 1) throw new Error(`Template has more than one extension module, keep one of ${files.join(", ")} in: ${join(directory, location)}`);
+			if (files.length === 1) return join(directory, location, files[0]);
+		}
+	}
+	async compile(input, stylesheets, files) {
 		const build = await rolldown({
 			input,
 			platform: "node",
-			logLevel: "silent",
+			logLevel: "warn",
+			onLog(_, log, handler) {
+				if (log.code === "UNRESOLVED_IMPORT") handler("error", {
+					...log,
+					message: `${log.message} Install it in the template directory: ${files.directory}`
+				});
+			},
 			plugins: [sveltePlugin({
-				template,
+				template: files.template,
 				components: _TemplateService.COMPONENTS,
+				templateComponents: files.components,
 				root: _TemplateService.ROOT,
-				stylesheets
+				stylesheets,
+				extension: files.extension
 			})]
 		});
 		try {
@@ -125,8 +221,9 @@ let TemplateService = class TemplateService {
 				format: "esm",
 				sourcemap: "inline"
 			});
+			const code = chunk.code.replaceAll("createRequire(import.meta.url)", `createRequire(${JSON.stringify(pathToFileURL(files.template).href)})`);
 			return {
-				module: await import(`data:text/javascript;base64,${Buffer.from(chunk.code).toString("base64")}`),
+				module: await import(`data:text/javascript;base64,${Buffer.from(code).toString("base64")}`),
 				modules: chunk.moduleIds.filter((id) => isAbsolute(id))
 			};
 		} finally {
@@ -149,7 +246,7 @@ let TemplateService = class TemplateService {
 		const theme = `:root { ${readFileSync(this.highlightTheme(highlight), "utf8")} pre:has(> code.hljs) { padding: 0; background: transparent; } }`;
 		const compiler = await compile([theme, ...bundle.stylesheets.map(({ source }) => source)].join("\n"), {
 			base: directory,
-			from: bundle.stylesheets[0]?.file ?? join(directory, "Template.svelte"),
+			from: bundle.stylesheets[0]?.file ?? bundle.template,
 			shouldRewriteUrls: true,
 			onDependency: (path) => dependencies.push(path),
 			customCssResolver: async (id, base) => this.resolveFrom(this.stylesheets, id, [

package/oclif.manifest.json

@@ -94,12 +94,26 @@
         },
         "template": {
           "char": "t",
-          "description": "Built-in template name or path to a template directory, defaults to \"default\". Overwrites the one defined in front-matter.",
+          "description": "Built-in template name or path to a template directory, defaults to \"default\", read as --template-type when given. Overwrites the one defined in front-matter.",
           "name": "template",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
+        "template-type": {
+          "description": "How to read --template, one of builtin, package or directory, like the type of the object form in front-matter.",
+          "name": "template-type",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "template-directory": {
+          "description": "Directory inside the package to use as the template, only valid with --template-type package.",
+          "name": "template-directory",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "title": {
           "char": "T",
           "description": "Document title. Overwrites the one defined in front-matter or the template.",
@@ -198,5 +212,5 @@
       "enableJsonFlag": false
     }
   },
-  "version": "3.2.24"
+  "version": "3.4.0"
 }

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@cenk1cenk2/md-printer",
-  "version": "3.2.24",
+  "version": "3.4.0",
   "description": "Render markdown or yaml through Svelte templates into PDF or HTML with Puppeteer.",
   "type": "module",
   "repository": {
     "type": "git",
-    "url": "https://gitlab.kilic.dev/utils/md-printer.git"
+    "url": "https://gitlab.kilic.dev/utils/md-printer.git",
+    "directory": "packages/md-printer"
   },
   "author": "Cenk Kilic",
   "license": "MIT",
@@ -18,8 +19,7 @@
   "files": [
     "/bin",
     "/dist",
-    "/oclif.manifest.json",
-    "templates/"
+    "/oclif.manifest.json"
   ],
   "oclif": {
     "bin": "md-printer",
@@ -49,11 +49,15 @@
     "cenk1cenk2"
   ],
   "dependencies": {
+    "@cenk1cenk2/md-printer-template-cv": "^1.0.0",
+    "@cenk1cenk2/md-printer-template-default": "1.1.0",
+    "@cenk1cenk2/md-printer-template-invoice": "^1.0.0",
+    "@cenk1cenk2/md-printer-template-kilic.dev": "1.1.0",
+    "@cenk1cenk2/md-printer-template-mail": "1.1.0",
     "@cenk1cenk2/oclif-common": "^8.0.2",
-    "@fontsource/montserrat": "^5.3.0",
     "@listr2/manager": "^4.3.3",
     "@nestjs/common": "^12.3.2",
-    "@oclif/core": "^5.1.10",
+    "@oclif/core": "^5.1.11",
     "@oclif/plugin-help": "^7.0.6",
     "@signpdf/placeholder-plain": "^4.0.0",
     "@signpdf/utils": "^4.0.0",
@@ -66,15 +70,15 @@
     "enhanced-resolve": "^5.26.0",
     "entities": "^9.0.0",
     "es-toolkit": "^1.53.1",
-    "github-markdown-css": "^5.9.0",
     "hast-util-from-html": "^2.0.3",
     "hast-util-to-html": "^9.0.6",
     "highlight.js": "^11.12.0",
-    "i18next": "^26.5.12",
+    "i18next": "^26.7.1",
     "lightningcss": "^1.33.0",
     "listr2": "^11.4.0",
     "lowlight": "^3.3.0",
     "mime": "^4.1.2",
+    "mupdf": "^1.28.1",
     "perfect-debounce": "^2.1.0",
     "pkijs": "^4.0.1",
     "property-information": "^7.2.0",
@@ -105,33 +109,21 @@
     "zod": "^4.6.7"
   },
   "devDependencies": {
-    "@cenk1cenk2/cz-cc": "^3.0.12",
-    "@cenk1cenk2/eslint-config": "^3.4.5",
     "@tsconfig/node24": "^24.0.5",
     "@types/hast": "^3.0.5",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^26.6.5",
+    "@types/node": "^26.6.6",
     "@types/serve-static": "^2.2.0",
     "@types/which": "^3.0.4",
     "@types/write-file-atomic": "^4.0.3",
-    "eslint": "^10.13.0",
-    "eslint-plugin-svelte": "^3.23.1",
     "execa": "^10.2.1",
     "oclif": "^6.0.15",
-    "prettier": "^3.9.10",
-    "prettier-plugin-svelte": "^4.1.1",
-    "svelte-eslint-parser": "^1.10.0",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
     "tsdown": "^0.23.4",
     "typescript": "^6.0.3",
     "vite": "^8.3.5",
-    "vitest": "^5.0.5"
-  },
-  "config": {
-    "commitizen": {
-      "path": "./node_modules/@cenk1cenk2/cz-cc"
-    }
+    "vitest": "^5.1.0"
   },
   "bugs": {
     "url": "https://gitlab.kilic.dev/utils/md-printer/-/issues"
@@ -142,8 +134,6 @@
     "start": "./bin/run.js",
     "build": "tsdown",
     "dev:start": "tsdown --watch src/",
-    "format": "prettier --write src/ --log-level warn && eslint --fix",
-    "lint": "eslint",
     "manifest": "oclif manifest",
     "typecheck": "tsc --noEmit",
     "test": "vitest run"

package/templates/default/Template.svelte

@@ -1,83 +0,0 @@
-<script>
-  import { Markdown, Page } from '@cenk1cenk2/md-printer/components'
-
-  let { data } = $props()
-</script>
-
-<svelte:head>
-  {#if data.documentTitle}
-    <title>{data.documentTitle}</title>
-  {/if}
-</svelte:head>
-
-<Page>
-  <Markdown />
-</Page>
-
-<style lang="postcss">
-  @import 'github-markdown-css/github-markdown-light.css';
-  @import '@fontsource/montserrat/latin-400.css';
-  @import '@fontsource/montserrat/latin-ext-400.css';
-  @import '@fontsource/montserrat/latin-700.css';
-  @import '@fontsource/montserrat/latin-ext-700.css';
-  @import '@fontsource/montserrat/latin-800.css';
-  @import '@fontsource/montserrat/latin-ext-800.css';
-
-  .markdown-body {
-    font-size: 11px;
-    font-family: 'Montserrat', sans-serif;
-  }
-
-  .markdown-body h1,
-  .markdown-body h2 {
-    font-weight: 800;
-  }
-
-  .markdown-body h3,
-  .markdown-body h4,
-  .markdown-body h5,
-  .markdown-body h6,
-  .markdown-body strong,
-  .markdown-body b {
-    font-weight: 700;
-  }
-
-  .markdown-body pre > code {
-    white-space: pre-wrap;
-    padding: 0;
-    margin: 0;
-  }
-
-  .markdown-body .document-title-header {
-    height: 500px;
-    margin: auto auto;
-    padding-top: 50%;
-    break-after: page;
-    border-bottom: 0;
-    font-size: 2.5em;
-  }
-
-  .markdown-body pre {
-    padding: 12px 8px;
-  }
-
-  .markdown-body output pre {
-    margin-top: -36px;
-    border-top-left-radius: 0;
-    border-top-right-radius: 0;
-    border-top: 2px solid #d1d9e0;
-  }
-
-  .markdown-body output::before {
-    padding: 4px 16px;
-    position: relative;
-    top: -24px;
-    border-top-left-radius: 4px;
-    border-top-right-radius: 4px;
-    border-top: 2px solid #d1d9e0;
-    color: #59636e;
-    background-color: #f6f8fa;
-    content: '> output';
-    font-size: 0.85em;
-  }
-</style>

package/templates/default/settings.json

@@ -1,7 +0,0 @@
-{
-  "pdfOptions": {
-    "format": "A4",
-    "margin": "18mm 12mm",
-    "printBackground": true
-  }
-}