drill-widgets 2.7.2

package/dist/lib.d.ts

@@ -0,0 +1,446 @@
+import { CSSResult } from 'lit';
+import { LitElement } from 'lit';
+import { TemplateResult } from 'lit-html';
+
+export declare type AssignmentCategory = "individual" | "role";
+
+export declare type AssignmentType = IndividualAssignmentType | RoleAssignmentType;
+
+declare interface BaseElement {
+    id: string;
+    type: string;
+    order: number;
+    metadata?: Record<string, any>;
+    visibility?: Visibility;
+}
+
+export declare interface BuilderConfig {
+    onWorkflowCreated?: (workflow: Workflow) => void;
+    onWorkflowDeleted?: (workflowId: string) => void;
+    onWorkflowUpdated?: (workflow: Workflow) => void;
+}
+
+export declare class BuilderWidget extends LitElement {
+    static styles: CSSResult;
+    private _templateData;
+    private _showStepModal;
+    private _stepFormData;
+    private _draggedStepId;
+    private _dragOverStepId;
+    private _selectedStepId;
+    private _questions;
+    onCancel?: () => void;
+    onSave?: (workflowJson: Workflow) => void;
+    onWorkflowCreated?: (workflow: Workflow) => void;
+    onWorkflowDeleted?: (workflowId: string) => void;
+    onWorkflowUpdated?: (workflow: Workflow) => void;
+    connectedCallback(): void;
+    private _getDefaultWorkflowData;
+    private _handleTitleChange;
+    private _handleDescriptionChange;
+    private _handleCancel;
+    private _handleSave;
+    private _addStep;
+    private _closeStepModal;
+    private _handleStepFormInput;
+    private _createStep;
+    private _selectStep;
+    private _getSelectedStep;
+    private _handleDragStart;
+    private _handleDragEnd;
+    private _handleDragOver;
+    private _handleDragLeave;
+    private _handleDrop;
+    private _addQuestion;
+    private _addContentElement;
+    private _updateQuestion;
+    private _updateContentElement;
+    private _deleteQuestion;
+    private _renderQuestionTypeSpecificFields;
+    private _renderContentTypeSpecificFields;
+    private _getQuestionTypeDisplayName;
+    private _getContentTypeDisplayName;
+    private _getCheckboxTypeDisplayName;
+    private _hasSteps;
+    private _getAssignmentDisplayText;
+    render(): TemplateResult<1>;
+}
+
+export declare interface ContentElement extends BaseElement {
+    type: "text" | "html" | "image" | "video" | "file" | "divider" | "markdown";
+    content: string;
+    url?: string;
+    alt?: string;
+    caption?: string;
+}
+
+/**
+ * Creates and mounts the Begin Workflow Builder widget.
+ * @param targetElementId The ID of the DOM element to mount the widget into.
+ * @param config Configuration options including callbacks.
+ */
+export declare function createBuilder(targetElementId: string, config?: BuilderConfig): BuilderWidget | null;
+
+/**
+ * Creates and mounts the Begin Workflow Runner widget.
+ * @param targetElementId The ID of the DOM element to mount the widget into.
+ * @param config Configuration options including instance and callbacks.
+ */
+export declare function createRunner(targetElementId: string, config: RunnerConfig): RunnerWidget | null;
+
+/**
+ * Generates print-ready HTML from a workflow instance
+ * This function replicates the print mode rendering from the runner widget
+ * but as a standalone utility that can be used server-side
+ */
+export declare function generateInstanceHTML(instance: Instance, options?: HTMLExportOptions): HTMLExportResult;
+
+export declare interface HTMLExportOptions {
+    title?: string;
+    includeStyles?: boolean;
+    customCSS?: string;
+    showTimestamps?: boolean;
+}
+
+export declare interface HTMLExportResult {
+    html: string;
+    title: string;
+    generatedAt: Date;
+}
+
+export declare type IndividualAssignmentType = "subject" | "creator" | "instance_assignee_select" | "specific_user";
+
+export declare interface Instance {
+    id: string;
+    workflowId: string;
+    name: string;
+    dueDate?: Date | null;
+    status: "draft" | "active" | "completed" | "canceled";
+    createdAt: Date;
+    updatedAt: Date;
+    steps: Step[];
+    currentStepId?: string;
+    completedSteps: string[];
+}
+
+/** @deprecated Use QuestionElement instead */
+export declare interface Question {
+    id: string;
+    label: string;
+    order: number;
+    type: "text" | "email" | "textarea" | "select" | "radio" | "checkbox" | "date" | "number" | "file_upload" | "signature";
+    required: boolean;
+    options?: string[];
+    placeholder?: string;
+    validation?: {
+        min?: number;
+        max?: number;
+        pattern?: string;
+    };
+}
+
+export declare interface QuestionElement extends BaseElement {
+    type: "text_input" | "textarea" | "select" | "number" | "radio" | "checkbox" | "date" | "file_upload" | "signature";
+    label: string;
+    required: boolean;
+    placeholder?: string;
+    options?: string[];
+    validations?: Record<string, any>;
+}
+
+export declare interface QuestionResponse {
+    elementId: string;
+    value: string | string[] | boolean | number | null;
+    answeredAt: Date;
+}
+
+/**
+ * Utility function to restore form data to a runner widget from an instance
+ * This can be used to restore form state after page refresh
+ * @param runnerWidget The runner widget instance
+ * @param instance The instance containing the form data to restore
+ */
+export declare function restoreFormDataToRunner(runnerWidget: RunnerWidget, instance: Instance): void;
+
+export declare type RoleAssignmentType = "instance_role_assignee_select";
+
+export declare interface RunnerConfig {
+    instance?: Instance;
+    workflow?: Workflow;
+    mode?: string;
+    isLoading?: boolean;
+    currentUser?: {
+        targetId: string;
+        email: string;
+    };
+    onInstanceUpdated?: (detail: {
+        instanceId?: string;
+        workflowId?: string;
+        completedStepId?: string;
+        completedStepData?: {
+            id: string;
+            title: string;
+            responses: QuestionResponse[];
+        } | null;
+        completedSteps: string[];
+        currentStep?: {
+            id: string;
+            title: string;
+        } | null;
+        mode?: string;
+    }) => void;
+    onSignatureCaptured?: (detail: {
+        instanceId?: string;
+        stepId?: string;
+        questionId: string;
+        svgData: string;
+        dataURL: string;
+    }) => void;
+    onFileUploaded?: (detail: {
+        instanceId?: string;
+        stepId?: string;
+        questionId: string;
+        file: File;
+        fileName: string;
+        fileSize: number;
+        fileType: string;
+    }) => void;
+}
+
+export declare class RunnerWidget extends LitElement {
+    static styles: CSSResult[];
+    instance?: Instance;
+    workflow?: Workflow;
+    mode?: string;
+    isLoading?: boolean;
+    currentUser?: {
+        targetId: string;
+        email: string;
+    };
+    onSignatureCaptured?: (detail: {
+        instanceId?: string;
+        stepId?: string;
+        questionId: string;
+        svgData: string;
+        dataURL: string;
+    }) => void;
+    onFileUploaded?: (detail: {
+        instanceId?: string;
+        stepId?: string;
+        questionId: string;
+        file: File;
+        fileName: string;
+        fileSize: number;
+        fileType: string;
+    }) => void;
+    private _currentStepIndex;
+    private _formData;
+    private _validationErrors;
+    private _internalCompletedSteps;
+    private _formRestorationComplete;
+    private _savedSignatures;
+    private _replacingSignatures;
+    private _savedInstance?;
+    private _isSubmitted;
+    private _userStepsSubmitted;
+    private _justSaved;
+    private validationService;
+    private persistenceManager;
+    private signatureManager;
+    private responseTracker;
+    private navigationService;
+    private formStateManager;
+    private fileUploadManager;
+    willUpdate(changedProperties: Map<string | symbol, unknown>): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private _initializeServices;
+    private _updateNavigationService;
+    private _updateValidationService;
+    private _getRenderContext;
+    private _handleSignatureChange;
+    private _clearValidationError;
+    private _updateFormData;
+    private _handleFormDataUpdate;
+    private _initializeState;
+    private _initializePreviewMode;
+    private _initializeDefaultMode;
+    private _initializeViewOnlyMode;
+    private _initializePrintMode;
+    private _isStepAssignedToUser;
+    private _getAssignedSteps;
+    private _isCurrentStepAssigned;
+    private _renderNotAssignedView;
+    private get _currentStep();
+    private _validateStep;
+    private _handleInputChange;
+    private _handleCheckboxChange;
+    private _handleCheckboxGroupChange;
+    private _initializeSignaturePad;
+    private _handleResize;
+    private _clearSignature;
+    private _startReplaceSignature;
+    private _cancelReplaceSignature;
+    private _saveSignature;
+    private _hasSignatureChanged;
+    private _restoreInstanceResponses;
+    private _handleFileUpload;
+    private _captureSignaturesFromStep;
+    private _trackQuestionResponse;
+    private _renderQuestion;
+    private _renderContentElement;
+    private static readonly QUESTION_ELEMENT_TYPES;
+    private static readonly CONTENT_ELEMENT_TYPES;
+    private _isQuestionElement;
+    private _isContentElement;
+    private _renderStepElement;
+    private _renderStepWithElements;
+    private _renderAllStepsForPrint;
+    private _nextStep;
+    private _findNextAssignedStep;
+    private _isLastAssignedStep;
+    private _isLastStepInWorkflow;
+    private _goToStep;
+    private _submitUserSteps;
+    private _submit;
+    private _saveStep;
+    private _clearSavedFormData;
+    private _scrollToTop;
+    private _updateInstanceData;
+    private _restoreFormData;
+    private _updateCompletedStepsFromCurrentIndex;
+    private _restoreFormDataFromDOM;
+    private _restoreFormValuesToDOM;
+    private _updateInstanceWithFormData;
+    private _restoreSignatures;
+    private _saveFormDataToHistory;
+    private _extractFormDataFromDOM;
+    private _updateInstanceFromFormData;
+    /**
+     * Public method to update the instance with current form data
+     * This can be called by the parent application to sync form data with the instance
+     * @param triggerCallback Whether to trigger the instance-updated callback
+     */
+    updateInstanceFromFormData(triggerCallback?: boolean): void;
+    /**
+     * Public method to get the current form data
+     * This can be used to extract form data for external processing
+     */
+    getFormData(): {
+        [questionId: string]: any;
+    };
+    /**
+     * Public method to restore form data from browser's form restoration
+     * This can be called manually if needed
+     */
+    restoreFormData(): void;
+    /**
+     * Public method to clear saved form data from localStorage
+     * This can be called to reset the form state
+     */
+    clearSavedFormData(reason?: string): void;
+    private _renderUnifiedSubmissionView;
+    /**
+     * Check if the instance status indicates the workflow is completed
+     */
+    private _isInstanceCompleted;
+    /**
+     * Check if all of the current user's assigned steps are marked as completed in the instance
+     * This is used when instance status is "active" but user has finished their part
+     */
+    private _areUserStepsCompleted;
+    /**
+     * Determine if we should show the completion view based on instance status
+     * This replaces the old internal state-based completion logic
+     */
+    private _shouldShowCompletionView;
+    /**
+     * Handles mode-based content routing and basic validation
+     * Returns content for special modes or null to continue with normal rendering
+     */
+    private _renderModeBasedContent;
+    /**
+     * Validates and returns the current step
+     * Returns null if current step is invalid
+     */
+    private _validateCurrentStep;
+    /**
+     * Initializes step-specific assets like signature pads and form restoration
+     */
+    private _initializeStepAssets;
+    /**
+     * Renders the layout for the current step including navigation and form content
+     */
+    private _renderCurrentStepLayout;
+    private _renderMainContent;
+    render(): TemplateResult<1>;
+}
+
+export declare interface Step {
+    id: string;
+    order: number;
+    title: string;
+    description?: string;
+    elements: StepElement[];
+    assignment: StepAssignment;
+    status: StepStatus;
+    responses?: QuestionResponse[];
+    metadata?: Record<string, any>;
+    visibility?: Visibility;
+}
+
+export declare interface StepAssignment {
+    category: AssignmentCategory;
+    type: AssignmentType;
+    targetId?: string;
+    targetName?: string;
+    email?: string;
+    roleId?: string;
+    userId?: string;
+    metadata?: Record<string, any>;
+}
+
+/** @deprecated Use StepAssignment instead */
+export declare interface StepAssignmentLegacy {
+    category: AssignmentCategory;
+    type: AssignmentType;
+    userId?: string;
+    userEmail?: string;
+    roleId?: string;
+}
+
+export declare type StepElement = ContentElement | QuestionElement;
+
+export declare type StepStatus = "pending" | "active" | "completed" | "skipped";
+
+/**
+ * Utility function to extract form data from a runner widget and update an instance
+ * This can be used to sync form data with an instance after page refresh
+ * @param runnerWidget The runner widget instance
+ * @param instance The instance to update
+ * @returns The updated instance with form data
+ */
+export declare function updateInstanceFromRunnerForm(runnerWidget: RunnerWidget, instance: Instance): Instance;
+
+export declare interface Visibility {
+    condition: "always" | "never" | "conditional";
+    logic?: "and" | "or";
+    rules?: VisibilityRule[];
+}
+
+export declare interface VisibilityRule {
+    type: "role" | "response" | "step_status";
+    operator: "equals" | "not_equals" | "contains" | "not_contains" | "in" | "not_in" | "exists" | "not_exists";
+    sourceId?: string;
+    value: any;
+}
+
+export declare interface Workflow {
+    id: string;
+    name: string;
+    description?: string;
+    steps: Step[];
+    assignment?: StepAssignment;
+}
+
+export { }

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "drill-widgets",
+  "version": "2.7.2",
+  "description": "Easily embed powerful workflow building and running capabilities into your web applications with Lit-based web components. Includes HTML export for server-side PDF generation.",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build && node scripts/build-html.js",
+    "preview": "vite preview",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "workflow",
+    "forms",
+    "lit",
+    "web-components",
+    "builder",
+    "runner",
+    "typescript",
+    "html-export",
+    "pdf-generation",
+    "server-side"
+  ],
+  "author": "Clay Grumieaux <claygrumeo@gmail.com>",
+  "license": "UNLICENSED",
+  "type": "module",
+  "main": "./dist/begin-widgets.umd.js",
+  "module": "./dist/begin-widgets.es.js",
+  "types": "./dist/lib.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/lib.d.ts",
+      "import": "./dist/begin-widgets.es.js",
+      "require": "./dist/begin-widgets.umd.js"
+    },
+    "./types": {
+      "types": "./dist/api-types.d.ts"
+    }
+  },
+  "dependencies": {
+    "lit": "^3.3.0",
+    "signature_pad": "^5.0.10",
+    "uuid": "^11.1.0",
+    "vite-plugin-dts": "^4.5.4"
+  },
+  "devDependencies": {
+    "@types/uuid": "^10.0.0",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/claygrumeo/begin-widgets.git"
+  },
+  "bugs": {
+    "url": "https://github.com/claygrumeo/begin-widgets/issues"
+  },
+  "homepage": "https://github.com/claygrumeo/begin-widgets#readme",
+  "files": [
+    "dist/*.js",
+    "dist/*.d.ts",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}