docx-kit 0.2.0 → 0.4.0

package/dist/loader-browser.d.ts

@@ -0,0 +1 @@
+export * from "@docxkit/loader/browser";

package/dist/loader-browser.js

@@ -0,0 +1 @@
+export * from "@docxkit/loader/browser";

package/dist/loader-node.d.ts

@@ -0,0 +1 @@
+export * from "@docxkit/loader/node";

package/dist/loader-node.js

@@ -0,0 +1,2 @@
+export * from "@docxkit/loader/node";
+export {};

package/dist/loader.d.ts

@@ -0,0 +1 @@
+export * from "@docxkit/loader";

package/dist/loader.js

@@ -0,0 +1 @@
+export * from "@docxkit/loader";

package/dist/mcp.d.ts

@@ -0,0 +1 @@
+export * from "@docxkit/mcp";

package/dist/mcp.js

@@ -0,0 +1,2 @@
+export * from "@docxkit/mcp";
+export {};

package/dist/node.d.ts

@@ -0,0 +1,109 @@
+import { BuiltinPluginMap, DocxBuilder, DocxKitConfig, DocxPlugin, DocxPreset, DocxSchema, DocxTheme, PluginRegistry, StyleSheet, dataUrlToUint8Array } from "@docxkit/core";
+import { academicPreset } from "@docxkit/preset-academic";
+import { classicPreset } from "@docxkit/preset-classic";
+import { modernPreset } from "@docxkit/preset-modern";
+import { minimalTheme } from "@docxkit/theme-minimal";
+import { oceanTheme } from "@docxkit/theme-ocean";
+import { warmTheme } from "@docxkit/theme-warm";
+import { Document } from "docx";
+import { TocOptions, TocOptions as TocOptions$1, tocPlugin } from "@docxkit/plugin-toc";
+import { BadgeOptions, BadgeOptions as BadgeOptions$1, badgePlugin } from "@docxkit/plugin-badge";
+import { QRCodePluginOptions, QRCodePluginOptions as QRCodePluginOptions$1, qrcodePlugin } from "@docxkit/plugin-qrcode";
+import { BarcodeFormat, BarcodeOptions, BarcodeOptions as BarcodeOptions$1, barcodePlugin } from "@docxkit/plugin-barcode";
+import { CalloutOptions, CalloutOptions as CalloutOptions$1, calloutPlugin } from "@docxkit/plugin-callout";
+import { DividerOptions, DividerOptions as DividerOptions$1, dividerPlugin } from "@docxkit/plugin-divider";
+import { InvoiceLineItem, InvoiceOptions, InvoiceOptions as InvoiceOptions$1, InvoiceParty, invoicePlugin } from "@docxkit/plugin-invoice";
+import { TimelineEvent, TimelineOptions, TimelineOptions as TimelineOptions$1, timelinePlugin } from "@docxkit/plugin-timeline";
+import { ChangelogEntry, ChangelogOptions, ChangelogOptions as ChangelogOptions$1, changelogPlugin } from "@docxkit/plugin-changelog";
+import { WatermarkOptions, WatermarkOptions as WatermarkOptions$1, watermarkPlugin } from "@docxkit/plugin-watermark";
+import { CodeBlockOptions, CodeBlockOptions as CodeBlockOptions$1, codeBlockPlugin } from "@docxkit/plugin-code-block";
+import { CoverPageOptions, CoverPageOptions as CoverPageOptions$1, coverPagePlugin } from "@docxkit/plugin-cover-page";
+import { ColAlign, ColFormat, DataTableOptions, DataTableOptions as DataTableOptions$1, dataTablePlugin } from "@docxkit/plugin-data-table";
+import { LetterheadOptions, LetterheadOptions as LetterheadOptions$1, letterheadPlugin } from "@docxkit/plugin-letterhead";
+import { PageNumberOptions, PageNumberOptions as PageNumberOptions$1, pageNumberPlugin } from "@docxkit/plugin-page-number";
+import { PropertyItem, PropertyTableOptions, PropertyTableOptions as PropertyTableOptions$1, propertyTablePlugin } from "@docxkit/plugin-property-table";
+import { AgendaItem, MeetingMinutesOptions, MeetingMinutesOptions as MeetingMinutesOptions$1, meetingMinutesPlugin } from "@docxkit/plugin-meeting-minutes";
+import { SignatureBlockOptions, SignatureBlockOptions as SignatureBlockOptions$1, SignatureParty, signatureBlockPlugin } from "@docxkit/plugin-signature-block";
+import { Readable } from "node:stream";
+import { EChartsPluginOptions } from "@docxkit/plugin-echarts";
+export * from "@docxkit/core";
+//#region src/node/fs.d.ts
+/**
+ * Save a compiled document to a file on disk.
+ *
+ * Streams the generated package to disk without materializing an additional
+ * complete output buffer. This function is **Node.js only**.
+ *
+ * @param doc - — A compiled `docx` `Document` instance
+ * @param filename - — Output file path (e.g. `"report.docx"`)
+ * @returns A promise that resolves when the file has been written
+ *
+ * @example
+ * ```ts
+ * import { saveDocument } from 'docx-kit/node'
+ *
+ * const doc = await compileDocument({ ... })
+ * await saveDocument(doc, 'report.docx')
+ * ```
+ */
+declare function saveDocument(doc: Document, filename: string): Promise<void>;
+/**
+ * Pack a compiled document as a Node.js stream.
+ *
+ * @param doc - — A compiled `docx` `Document` instance
+ * @returns A readable stream containing the DOCX package
+ */
+declare function streamDocument(doc: Document): Readable;
+//#endregion
+//#region src/types/plugin-map.d.ts
+declare module '@docxkit/core' {
+  interface BuiltinPluginMap {
+    badge: BadgeOptions$1;
+    barcode: BarcodeOptions$1;
+    callout: CalloutOptions$1;
+    changelog: ChangelogOptions$1;
+    codeBlock: CodeBlockOptions$1;
+    coverPage: CoverPageOptions$1;
+    dataTable: DataTableOptions$1;
+    divider: DividerOptions$1;
+    echarts: EChartsPluginOptions;
+    invoice: InvoiceOptions$1;
+    letterhead: LetterheadOptions$1;
+    meetingMinutes: MeetingMinutesOptions$1;
+    pageNumber: PageNumberOptions$1;
+    propertyTable: PropertyTableOptions$1;
+    qrcode: QRCodePluginOptions$1;
+    signatureBlock: SignatureBlockOptions$1;
+    timeline: TimelineOptions$1;
+    toc: TocOptions$1;
+    watermark: WatermarkOptions$1;
+  }
+}
+//#endregion
+//#region src/node.d.ts
+/**
+ * A {@link DocxBuilder} with the Node.js filesystem save adapter installed.
+ */
+interface NodeDocxBuilder<TStyles extends StyleSheet = StyleSheet, TPlugins extends PluginRegistry = BuiltinPluginMap & PluginRegistry> extends DocxBuilder<TStyles, TPlugins> {
+  /** Save the generated document to the local filesystem. */
+  save: (filename: string) => Promise<void>;
+  /** Pack the generated document as a Node.js stream. */
+  toStream: () => Promise<Readable>;
+  use: <TName extends string, TOptions, TRender>(plugin: DocxPlugin<TName, TOptions, TRender>) => NodeDocxBuilder<TStyles, Record<TName, TOptions> & TPlugins>;
+}
+/**
+ * Create a fluent document builder with Node.js filesystem saving enabled.
+ */
+declare function createDocx<const TStyles extends StyleSheet = StyleSheet>(config?: DocxKitConfig<TStyles>): NodeDocxBuilder<TStyles>;
+/**
+ * Render a JSON document schema with Node.js filesystem saving enabled.
+ */
+declare function renderDocx<const TStyles extends StyleSheet = StyleSheet>(schema: DocxSchema<TStyles>): Promise<NodeDocxBuilder<TStyles>>;
+declare const BUILTIN_PRESETS: ReadonlyMap<string, DocxPreset>;
+declare const PRESET_LIST: readonly DocxPreset[];
+declare function usePreset(id: string): DocxPreset | undefined;
+declare const BUILTIN_THEMES: ReadonlyMap<string, DocxTheme>;
+declare const THEME_LIST: readonly DocxTheme[];
+declare function useTheme(id: string): DocxTheme | undefined;
+//#endregion
+export { type AgendaItem, BUILTIN_PRESETS, BUILTIN_THEMES, type BadgeOptions, type BarcodeFormat, type BarcodeOptions, type CalloutOptions, type ChangelogEntry, type ChangelogOptions, type CodeBlockOptions, type ColAlign, type ColFormat, type CoverPageOptions, type DataTableOptions, type DividerOptions, type InvoiceLineItem, type InvoiceOptions, type InvoiceParty, type LetterheadOptions, type MeetingMinutesOptions, NodeDocxBuilder, PRESET_LIST, type PageNumberOptions, type PropertyItem, type PropertyTableOptions, type QRCodePluginOptions, type SignatureBlockOptions, type SignatureParty, THEME_LIST, type TimelineEvent, type TimelineOptions, type TocOptions, type WatermarkOptions, academicPreset, badgePlugin, barcodePlugin, calloutPlugin, changelogPlugin, classicPreset, codeBlockPlugin, coverPagePlugin, createDocx, dataTablePlugin, dataUrlToUint8Array, dividerPlugin, invoicePlugin, letterheadPlugin, meetingMinutesPlugin, minimalTheme, modernPreset, oceanTheme, pageNumberPlugin, propertyTablePlugin, qrcodePlugin, renderDocx, saveDocument, signatureBlockPlugin, streamDocument, timelinePlugin, tocPlugin, usePreset, useTheme, warmTheme, watermarkPlugin };

package/dist/node.js

@@ -0,0 +1,122 @@
+import { createDocx as createDocx$1, dataUrlToUint8Array, renderDocx as renderDocx$1 } from "@docxkit/core";
+import { academicPreset } from "@docxkit/preset-academic";
+import { classicPreset } from "@docxkit/preset-classic";
+import { modernPreset } from "@docxkit/preset-modern";
+import { minimalTheme } from "@docxkit/theme-minimal";
+import { oceanTheme } from "@docxkit/theme-ocean";
+import { warmTheme } from "@docxkit/theme-warm";
+import { Packer } from "docx";
+import { tocPlugin } from "@docxkit/plugin-toc";
+import { badgePlugin } from "@docxkit/plugin-badge";
+import { qrcodePlugin } from "@docxkit/plugin-qrcode";
+import { barcodePlugin } from "@docxkit/plugin-barcode";
+import { calloutPlugin } from "@docxkit/plugin-callout";
+import { dividerPlugin } from "@docxkit/plugin-divider";
+import { invoicePlugin } from "@docxkit/plugin-invoice";
+import { timelinePlugin } from "@docxkit/plugin-timeline";
+import { changelogPlugin } from "@docxkit/plugin-changelog";
+import { watermarkPlugin } from "@docxkit/plugin-watermark";
+import { codeBlockPlugin } from "@docxkit/plugin-code-block";
+import { coverPagePlugin } from "@docxkit/plugin-cover-page";
+import { dataTablePlugin } from "@docxkit/plugin-data-table";
+import { letterheadPlugin } from "@docxkit/plugin-letterhead";
+import { pageNumberPlugin } from "@docxkit/plugin-page-number";
+import { propertyTablePlugin } from "@docxkit/plugin-property-table";
+import { meetingMinutesPlugin } from "@docxkit/plugin-meeting-minutes";
+import { signatureBlockPlugin } from "@docxkit/plugin-signature-block";
+export * from "@docxkit/core";
+//#region src/node/fs.ts
+/**
+* Node.js filesystem utilities for saving documents to disk.
+*
+* @module node/fs
+*/
+/**
+* Save a compiled document to a file on disk.
+*
+* Streams the generated package to disk without materializing an additional
+* complete output buffer. This function is **Node.js only**.
+*
+* @param doc - — A compiled `docx` `Document` instance
+* @param filename - — Output file path (e.g. `"report.docx"`)
+* @returns A promise that resolves when the file has been written
+*
+* @example
+* ```ts
+* import { saveDocument } from 'docx-kit/node'
+*
+* const doc = await compileDocument({ ... })
+* await saveDocument(doc, 'report.docx')
+* ```
+*/
+async function saveDocument(doc, filename) {
+	const [{ createWriteStream }, { pipeline }] = await Promise.all([import("node:fs"), import("node:stream/promises")]);
+	await pipeline(streamDocument(doc), createWriteStream(filename));
+}
+/**
+* Pack a compiled document as a Node.js stream.
+*
+* @param doc - — A compiled `docx` `Document` instance
+* @returns A readable stream containing the DOCX package
+*/
+function streamDocument(doc) {
+	return Packer.toStream(doc);
+}
+//#endregion
+//#region src/node.ts
+/**
+* docx-kit — Node.js platform entry.
+*
+* Import from 'docx-kit/node'.
+*
+* @module docx-kit/node
+* @packageDocumentation
+*/
+/**
+* Create a fluent document builder with Node.js filesystem saving enabled.
+*/
+function createDocx(config = {}) {
+	return attachNodeSave(createDocx$1(config));
+}
+/**
+* Render a JSON document schema with Node.js filesystem saving enabled.
+*/
+async function renderDocx(schema) {
+	return attachNodeSave(await renderDocx$1(schema));
+}
+function attachNodeSave(builder) {
+	const nodeBuilder = builder;
+	nodeBuilder.save = async (filename) => {
+		await saveDocument(await nodeBuilder.toDocument(), filename);
+	};
+	nodeBuilder.toStream = async () => streamDocument(await nodeBuilder.toDocument());
+	return nodeBuilder;
+}
+const BUILTIN_PRESETS = /* @__PURE__ */ new Map([
+	[academicPreset.id, academicPreset],
+	[classicPreset.id, classicPreset],
+	[modernPreset.id, modernPreset]
+]);
+const PRESET_LIST = [
+	classicPreset,
+	modernPreset,
+	academicPreset
+];
+function usePreset(id) {
+	return BUILTIN_PRESETS.get(id);
+}
+const BUILTIN_THEMES = /* @__PURE__ */ new Map([
+	[minimalTheme.id, minimalTheme],
+	[oceanTheme.id, oceanTheme],
+	[warmTheme.id, warmTheme]
+]);
+const THEME_LIST = [
+	minimalTheme,
+	oceanTheme,
+	warmTheme
+];
+function useTheme(id) {
+	return BUILTIN_THEMES.get(id);
+}
+//#endregion
+export { BUILTIN_PRESETS, BUILTIN_THEMES, PRESET_LIST, THEME_LIST, academicPreset, badgePlugin, barcodePlugin, calloutPlugin, changelogPlugin, classicPreset, codeBlockPlugin, coverPagePlugin, createDocx, dataTablePlugin, dataUrlToUint8Array, dividerPlugin, invoicePlugin, letterheadPlugin, meetingMinutesPlugin, minimalTheme, modernPreset, oceanTheme, pageNumberPlugin, propertyTablePlugin, qrcodePlugin, renderDocx, saveDocument, signatureBlockPlugin, streamDocument, timelinePlugin, tocPlugin, usePreset, useTheme, warmTheme, watermarkPlugin };

package/dist/pdk.d.ts

@@ -0,0 +1 @@
+export * from "@docxkit/pdk";

package/dist/pdk.js

@@ -0,0 +1 @@
+export * from "@docxkit/pdk";

package/dist/registry.d.ts

@@ -0,0 +1 @@
+export * from "@docxkit/registry";

package/dist/registry.js

@@ -0,0 +1,2 @@
+export * from "@docxkit/registry";
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docx-kit",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "CSS-like DOCX API Kit — a type-safe, plugin-extensible DOCX generation library built on dolanmiu/docx.",
   "keywords": [
     "document",
@@ -21,7 +21,8 @@
   "homepage": "https://github.com/ntnyq/docx-kit#readme",
   "repository": {
     "type": "git",
-    "url": "ntnyq/docx-kit"
+    "url": "https://github.com/ntnyq/docx-kit",
+    "directory": "packages/docx-kit"
   },
   "bugs": {
     "url": "https://github.com/ntnyq/docx-kit/issues"
@@ -32,13 +33,41 @@
       "types": "./dist/browser.d.ts",
       "default": "./dist/browser.js"
     },
+    "./ai": {
+      "types": "./dist/ai.d.ts",
+      "default": "./dist/ai.js"
+    },
     "./browser": {
       "types": "./dist/browser.d.ts",
       "default": "./dist/browser.js"
     },
+    "./loader": {
+      "types": "./dist/loader.d.ts",
+      "default": "./dist/loader.js"
+    },
+    "./loader/browser": {
+      "types": "./dist/loader-browser.d.ts",
+      "default": "./dist/loader-browser.js"
+    },
+    "./loader/node": {
+      "types": "./dist/loader-node.d.ts",
+      "default": "./dist/loader-node.js"
+    },
+    "./mcp": {
+      "types": "./dist/mcp.d.ts",
+      "default": "./dist/mcp.js"
+    },
     "./node": {
-      "types": "./dist/node.d.mts",
-      "default": "./dist/node.mjs"
+      "types": "./dist/node.d.ts",
+      "default": "./dist/node.js"
+    },
+    "./pdk": {
+      "types": "./dist/pdk.d.ts",
+      "default": "./dist/pdk.js"
+    },
+    "./registry": {
+      "types": "./dist/registry.d.ts",
+      "default": "./dist/registry.js"
     }
   },
   "main": "./dist/browser.js",
@@ -51,56 +80,44 @@
   },
   "sideEffects": false,
   "peerDependencies": {
-    "echarts": ">=5.0.0",
-    "highlight.js": ">=11.0.0",
-    "qrcode": ">=1.5.0"
-  },
-  "peerDependenciesMeta": {
-    "echarts": {
-      "optional": true
-    },
-    "highlight.js": {
-      "optional": true
-    },
-    "qrcode": {
-      "optional": true
-    }
-  },
-  "dependencies": {
     "docx": "^9.7.1"
   },
-  "devDependencies": {
-    "@ntnyq/eslint-config": "^6.1.5",
-    "@ntnyq/prettier-config": "^3.0.1",
-    "@types/node": "^25.9.2",
-    "@types/qrcode": "^1.5.6",
-    "bumpp": "^11.1.0",
-    "echarts": "^6.1.0",
-    "eslint": "^10.4.1",
-    "husky": "^9.1.7",
-    "nano-staged": "^1.0.2",
-    "npm-run-all2": "^9.0.1",
-    "prettier": "^3.8.4",
-    "qrcode": "^1.5.4",
-    "tsdown": "^0.22.2",
-    "typescript": "^6.0.3",
-    "vite": "^8.0.16",
-    "vitest": "^4.1.8"
-  },
-  "nano-staged": {
-    "*.{js,ts,mjs,cjs,md,vue,yml,yaml,toml,json}": "eslint --fix",
-    "*.{css,scss,html}": "prettier -uw"
+  "dependencies": {
+    "@docxkit/ai": "0.4.0",
+    "@docxkit/core": "0.4.0",
+    "@docxkit/pdk": "0.4.0",
+    "@docxkit/mcp": "0.4.0",
+    "@docxkit/plugin-callout": "0.4.0",
+    "@docxkit/plugin-badge": "0.4.0",
+    "@docxkit/plugin-barcode": "0.4.0",
+    "@docxkit/loader": "0.4.0",
+    "@docxkit/plugin-changelog": "0.4.0",
+    "@docxkit/plugin-code-block": "0.4.0",
+    "@docxkit/plugin-cover-page": "0.4.0",
+    "@docxkit/plugin-data-table": "0.4.0",
+    "@docxkit/plugin-echarts": "0.4.0",
+    "@docxkit/plugin-invoice": "0.4.0",
+    "@docxkit/plugin-letterhead": "0.4.0",
+    "@docxkit/plugin-divider": "0.4.0",
+    "@docxkit/plugin-meeting-minutes": "0.4.0",
+    "@docxkit/plugin-property-table": "0.4.0",
+    "@docxkit/plugin-qrcode": "0.4.0",
+    "@docxkit/plugin-page-number": "0.4.0",
+    "@docxkit/plugin-signature-block": "0.4.0",
+    "@docxkit/plugin-toc": "0.4.0",
+    "@docxkit/plugin-timeline": "0.4.0",
+    "@docxkit/plugin-watermark": "0.4.0",
+    "@docxkit/preset-academic": "0.4.0",
+    "@docxkit/preset-classic": "0.4.0",
+    "@docxkit/registry": "0.4.0",
+    "@docxkit/preset-modern": "0.4.0",
+    "@docxkit/renderer": "0.4.0",
+    "@docxkit/theme-warm": "0.4.0",
+    "@docxkit/theme-minimal": "0.4.0",
+    "@docxkit/theme-ocean": "0.4.0"
   },
   "scripts": {
     "build": "tsdown",
-    "dev": "tsdown --watch",
-    "docs:build": "pnpm -C docs run build",
-    "docs:dev": "pnpm -C docs run dev",
-    "lint": "eslint",
-    "release": "run-s release:check release:version",
-    "release:check": "run-s lint typecheck test",
-    "release:version": "bumpp",
-    "test": "vitest",
-    "typecheck": "tsc --noEmit"
+    "dev": "tsdown --watch"
   }
 }