@lateralus-ai/shipping-ui 1.2.0 → 1.3.1

package/dist/types/documentEditor.d.ts

@@ -0,0 +1,47 @@
+export interface SchemaProperty {
+    type: "string" | "boolean" | "number" | "integer";
+    enum?: string[];
+    format?: "date" | "date-time" | string;
+    description?: string;
+    title?: string;
+    "ui:widget"?: string;
+    "ui:rows"?: number;
+    docx_mapping?: DocxMapping;
+}
+export interface DocxMapping {
+    type: "checkbox" | "radio" | "text";
+    name?: string;
+    true_name?: string;
+    false_name?: string;
+    mapping?: RadioMapping[];
+}
+export interface RadioMapping {
+    name: string;
+    value: string | boolean;
+}
+export interface Schema {
+    type: string;
+    properties: Record<string, SchemaProperty>;
+    required?: string[];
+}
+export interface CheckboxModuleOptions {
+    checkboxData?: Record<string, boolean>;
+    schema?: Schema;
+    finalGeneration?: boolean;
+}
+export interface DocumentEditorProps {
+    docxUrl: string;
+    schema: Schema;
+    onDataChange?: (data: Record<string, any>) => void;
+    initialData?: Record<string, any>;
+    onSaveRef?: React.MutableRefObject<(() => void) | null>;
+    readonly?: boolean;
+}
+export interface DocxtemplaterPart {
+    value?: string;
+    [key: string]: any;
+}
+export interface DocxtemplaterOptions {
+    contentType?: string;
+    [key: string]: any;
+}

package/dist/utils/checkboxModule.d.ts

@@ -0,0 +1,54 @@
+import { CheckboxModuleOptions, DocxtemplaterPart, DocxtemplaterOptions } from '../types/documentEditor';
+/**
+ * CheckboxModule for docxtemplater
+ *
+ * This module handles three distinct checkbox patterns in DOCX documents:
+ *
+ * 1. **Single Checkbox Pattern**: A field maps to a single checkbox
+ *    - Schema: `docx_mapping: { type: "checkbox", name: "Check1" }`
+ *    - Maps boolean field value directly to checkbox state
+ *
+ * 2. **Dual Checkbox Pattern**: Yes/No checkboxes for a single field
+ *    - Schema: `docx_mapping: { type: "checkbox", true_name: "Check1", false_name: "Check2" }`
+ *    - true_name checkbox checked when field is true
+ *    - false_name checkbox checked when field is false
+ *    - Used for Yes/No questions where both options have checkboxes
+ *
+ * 3. **Radio Button Pattern**: Multiple checkboxes acting as radio buttons
+ *    - Schema: `docx_mapping: { type: "radio", mapping: [{ name: "Check1", value: "option1" }, ...] }`
+ *    - Only the checkbox corresponding to the field's value is checked
+ *    - Used for multiple choice questions
+ *
+ * The module operates in two modes:
+ * - **Preview Mode** (finalGeneration: false): Creates visual markers for inline editing
+ * - **Final Generation Mode** (finalGeneration: true): Updates actual Word form fields
+ */
+declare class CheckboxModule {
+    private checkboxData;
+    private schema?;
+    private finalGeneration;
+    constructor(options?: CheckboxModuleOptions);
+    name: string;
+    parse(placeHolderContent: string): null;
+    postparse(parsed: any): any;
+    render(part: any, options: any): any;
+    postrender(parts: DocxtemplaterPart[], options: DocxtemplaterOptions): string[] | DocxtemplaterPart[];
+    /**
+     * Process checkbox patterns in the document XML
+     * Identifies Word form field checkboxes by their bookmark names (Check1, Check2, etc.)
+     * and either updates their values or replaces them with visual markers
+     */
+    private processCheckboxPatterns;
+    /**
+     * Determine the state of a checkbox based on field mappings and data
+     * @param checkboxName - The name of the checkbox (e.g., "Check1")
+     * @returns true if checkbox should be checked, false otherwise
+     */
+    private getCheckboxState;
+    /**
+     * Update checkbox data (can be called to change checkbox states)
+     * @param checkboxData - New checkbox data to merge with existing data
+     */
+    updateCheckboxData(checkboxData: Record<string, boolean>): void;
+}
+export default CheckboxModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lateralus-ai/shipping-ui",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Shared UI theme and components for Lateralus shipping applications",
   "main": "dist/index.cjs",
   "module": "dist/index.esm.js",
@@ -82,6 +82,9 @@
   "dependencies": {
     "@iconify/react": "^6.0.2",
     "@react-hooks-library/core": "^0.6.2",
+    "docx-preview": "^0.3.7",
+    "docxtemplater": "^3.66.6",
+    "pizzip": "^3.2.0",
     "react-hotkeys-hook": "^5.1.0",
     "react-pdf": "^10.1.0",
     "react-router": "^7.9.3"