dsh-tool-docx 0.5.0

package/lib/types/types.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Shared vocabulary for the docx tool suite: the structured block model a
+ * document is extracted into and regenerated from, the preserved document
+ * properties, and the full extraction result.
+ * @module dsh-tool-docx/types
+ */
+/** One structured content block. `image` blocks appear in read output only; the generator emits a warning instead of embedding bytes. */
+export type DocxBlock = {
+    kind: 'heading';
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    text: string;
+} | {
+    kind: 'paragraph';
+    text: string;
+} | {
+    kind: 'list';
+    ordered: boolean;
+    items: Array<{
+        level: number;
+        text: string;
+    }>;
+} | {
+    kind: 'table';
+    header: string[] | null;
+    rows: string[][];
+} | {
+    kind: 'image';
+    alt: string;
+};
+/** Document properties preserved across a round-trip edit (from `docProps/core.xml`). */
+export interface DocxProps {
+    /** `dc:title`, or null when absent. */
+    title: string | null;
+    /** `dc:creator`, or null when absent. */
+    author: string | null;
+    /** `dcterms:created` (ISO-8601), or null when absent. */
+    created: string | null;
+}
+/** The full result of extracting one `.docx` buffer. */
+export interface ExtractedDocx {
+    props: DocxProps;
+    /** Markdown rendering of the document body. */
+    markdown: string;
+    /** Structured block rendering of the document body. */
+    blocks: DocxBlock[];
+    /** Number of embedded images encountered (emitted as placeholders). */
+    images: number;
+    /** Human-readable notes about approximations and unsupported constructs. */
+    warnings: string[];
+}
+/** DocProps + warnings, what the edit tool needs from the existing file. */
+export interface ExtractedEditBasis {
+    props: DocxProps;
+    warnings: string[];
+}
+/** Canonical tool output for `docx_read`. */
+export interface DocxReadValue {
+    path: string;
+    format: 'markdown' | 'json';
+    docProps: DocxProps;
+    charCount: number;
+    images: number;
+    warnings: string[];
+    markdown: string | null;
+    blocks: DocxBlock[] | null;
+}
+/** Canonical tool output for `docx_create` / `docx_edit`. */
+export interface DocxWriteValue {
+    path: string;
+    operation: 'create' | 'update';
+    /** Byte size of the generated document. */
+    bytes: number;
+    warnings: string[];
+    /** Present only for an edit (the preserved properties). */
+    docProps?: DocxProps;
+}
+//# sourceMappingURL=types.d.ts.map

package/package.json

@@ -0,0 +1,114 @@
+{
+  "name": "dsh-tool-docx",
+  "description": "Model-facing MS Word (.docx) tools: read documents as Markdown or structured blocks, create documents from Markdown, and edit documents round-trip; ships binary fs providers (writeBytes, incl. a sandbox-preserving one) for hosts without it",
+  "version": "0.5.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BroBFG/dsh-tool-docx.git"
+  },
+  "keywords": [
+    "deepseek-harness",
+    "dsh",
+    "dsh-plugin",
+    "docx",
+    "word",
+    "markdown",
+    "microsoft-word"
+  ],
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./fs-binary-local": {
+      "types": "./lib/types/fs-binary-local.d.ts",
+      "default": "./lib/fs-binary-local.js"
+    },
+    "./fs-binary-sandbox": {
+      "types": "./lib/types/fs-binary-sandbox.d.ts",
+      "default": "./lib/fs-binary-sandbox.js"
+    },
+    "./fs-binary-local-plugin": {
+      "types": "./lib/types/fs-binary-local-plugin.d.ts",
+      "default": "./lib/fs-binary-local-plugin.js"
+    },
+    "./fs-binary-sandbox-plugin": {
+      "types": "./lib/types/fs-binary-sandbox-plugin.d.ts",
+      "default": "./lib/fs-binary-sandbox-plugin.js"
+    },
+    "./invariant": {
+      "types": "./lib/types/invariant.d.ts",
+      "default": "./lib/invariant.js"
+    },
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib/*.js",
+    "lib/types/**/*.d.ts",
+    "cordis.patch.yml"
+  ],
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    }
+  },
+  "license": "MIT",
+  "engines": {
+    "node": "^22.19.0 || >=24.0.0"
+  },
+  "dependencies": {
+    "@deepseek-ai/schemastery": "^3.18.1",
+    "docx": "^9.7.1",
+    "fast-xml-parser": "^4.5.7",
+    "jszip": "^3.10.1",
+    "yauzl": "^2.10.0"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/dsh-fs": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-fs-local": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-fs-sandbox": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-invariants": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-llm": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-sandbox": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-sandbox-policy": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-session": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-system-prompt": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-tools": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-user-approval": "^0.1.0-rc.7",
+    "@deepseek-ai/cordis": "^4.0.1"
+  },
+  "devDependencies": {
+    "@deepseek-ai/dsh-fs": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-fs-local": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-fs-sandbox": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-invariants": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-llm": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-sandbox": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-sandbox-policy": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-scope": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-session": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-system-prompt": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-timeout": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-tools": "^0.1.0-rc.7",
+    "@deepseek-ai/dsh-user-approval": "^0.1.0-rc.7",
+    "@deepseek-ai/cordis": "^4.0.1",
+    "@types/node": "^24.0.0",
+    "@types/yauzl": "^2.10.3",
+    "tsdown": "^0.22.2",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.8"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsdown",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "verify:lib": "pnpm build && git diff --exit-code -- lib/"
+  }
+}