@unvired/turboforms-embed-sdk 2.0.47 → 2.0.49

package/dist/index.d.ts

@@ -0,0 +1,268 @@
+// TypeScript definitions for unvired-forms-lib
+
+
+export interface loadFormOptions {
+  nestedFormData?: any[];
+  masterData?: any[];
+
+  mode?: "pdf" | "readOnly" | "form" | "render" | "print" | string;
+  platform?: "android" | "web" | "ios" | string;
+  permission?: "writemultiple" | "writesingle" | "read" | string;
+  language?: string;
+  privateExternal?: string | boolean;
+  title?: string;
+  description?: string;
+
+  translations?: any;
+  themeData?: any;
+  userData?: any;
+  controlData?: any;
+
+  commentsData?: any[];
+  vobArr?: any[];
+  appData?: any[];
+  environmentVariable?: any[];
+
+  showComments?: boolean;
+  showDocuments?: boolean;
+  showHelp?: boolean;
+  showBackButton?: boolean;
+  showLoader?: boolean;
+  showMoreButton?: boolean;
+  showFooter?: boolean;
+  showHeader?: boolean;
+
+  showCompleteAlways?: boolean;
+  requireCompleteForm?: boolean;
+
+}
+
+// Event Types
+export const FORM_EVENTS: {
+  FORM_RENDER: "FORM_RENDER";
+  SAVE: "FORM_SAVE";
+  SUBMIT: "FORM_SUBMIT";
+  SUBMIT_ERROR: "FORM_SUBMIT_ERROR";
+  BACK_NAVIGATION: "FORM_BACK_NAVIGATION";
+  ONCHANGE: "FORM_ONCHANGE";
+  ACTION: "ACTION";
+  GET_ATTACHMENT: "GET_ATTACHMENT";
+  FORM_LOADED: "FORM_LOADED";
+};
+
+// Event Structures
+export interface SuccessEvent {
+  type:
+  | "FORM_RENDER"
+  | "FORM_SAVE"
+  | "FORM_SUBMIT"
+  | "FORM_BACK_NAVIGATION"
+  | "FORM_ONCHANGE"
+  | "ACTION"
+  | "OPEN_CAMERA"
+  | "BARCODE_SCAN"
+  | "LOCATION_REQUEST"
+  | "GET_ATTACHMENT";
+  message: string;
+  data: {
+    formData?: any;
+    templateData?: any;
+    completeFlag?: boolean;
+    completionPercentage?: number;
+    result?: any;
+    controlId?: string;
+    scannedValue?: string;
+    location?: string;
+    coordinates?: { lat: number; lng: number };
+    fileName?: string;
+    missingFiles?: Array<{ fileId: string; field: string }>;
+    [key: string]: any;
+  };
+}
+
+export interface ErrorEvent {
+  type: "ERROR"
+  errorMessage: string;
+  data: {
+    technicalError?: any;
+    reason?: string;
+    error?: any;
+    formData?: any;
+    completeFlag?: boolean;
+    completionPercentage?: number;
+    [key: string]: any;
+  };
+}
+
+export type FormEvent = SuccessEvent | ErrorEvent;
+
+// Error Codes Reference
+export const ERROR_CODES: {
+  "001": "Invalid formsData JSON";
+  "002": "Nested form validation error";
+  "003": "Master data validation error";
+  "004": "User Data not Provided";
+  "005": "Formio not rendered the forms";
+  "006": "Formio not submit the form";
+  "008": "Location permission denied";
+  "009": "Location unavailable";
+  "010": "Location request timeout";
+  "011": "Location unknown error";
+  "012": "Camera access error";
+  "013": "Attachments missing from storage";
+  "014": "Failed to validate attachments";
+  "015": "File not found in IndexedDB during processing";
+  "016": "Formio library not loaded";
+  "017": "Document not found";
+  "018": "Invalid file format";
+  "019": "File is corrupted (invalid base64)";
+  "020": "File is empty";
+  "021": "File is corrupted (invalid encoding)";
+  "022": "Failed to process file";
+  "023": "File is empty";
+  "024": "No downloadable content found";
+  "025": "Failed to load documents";
+
+};
+
+// Event Callback Function
+export type EventCallback = (event: FormEvent) => void;
+
+// Main Function Interface
+export interface loadFormParams {
+  formsData: string | any;
+  submissionData?: any;
+  eventCallback?: EventCallback;
+  container?: HTMLElement;
+  options?: loadFormOptions;
+}
+
+export interface AttachmentInfo {
+  id: string;
+  name: string;
+  originalName: string;
+  size: number;
+  type: string;
+  url: string;
+}
+
+export interface FormInstance {
+  sendAction: (action: any) => void;
+  getAttachments?: () => Promise<AttachmentInfo[]>;
+  clearAttachments?: () => Promise<boolean>;
+  validateAttachments?: (formData: any) => void;
+  deleteAttachment?: (fileId: string) => Promise<boolean>;
+}
+
+export function loadForm(params: loadFormParams): FormInstance;
+
+export function getBuildVersion(): string;
+
+// Events that will be triggered:
+
+/**
+ * SUCCESS EVENTS:
+ *
+ * 1. FORM_RENDER - Form rendered successfully
+ *    { type: "FORM_RENDER", message: "Success: Form rendered successfully.", data: {} }
+ *
+ * 2. FORM_ONCHANGE - Form data changed
+ *    { type: "FORM_ONCHANGE", message: "Success: Form onchange triggered.", data: { formData: submission, templateData: template } }
+ *
+ * 3. FORM_SUBMIT - Form submitted successfully
+ *    { type: "FORM_SUBMIT", message: "Success: Form submitted successfully.", data: { formData: currentData, completeFlag, completionPercentage, result } }
+ *
+ * 4. FORM_SAVE - Form data saved
+ *    { type: "FORM_SAVE", message: "Success: Data saved successfully.", data: { formData: updatedData, completeFlag, completionPercentage } }
+ *
+ * 5. FORM_BACK_NAVIGATION - Back navigation triggered
+ *    { type: "FORM_BACK_NAVIGATION", message: "Back navigation triggered.", data: {} }
+ *
+ * 6. OPEN_CAMERA - Photo captured successfully
+ *    { type: "OPEN_CAMERA", message: "Photo captured successfully", data: { controlId: "id", fileName: "photo.jpg" } }
+ *
+ * 7. BARCODE_SCAN - Barcode scanned successfully
+ *    { type: "BARCODE_SCAN", message: "Barcode scanned successfully", data: { controlId: "id", scannedValue: "value" } }
+ *
+ * 8. LOCATION_REQUEST - Location retrieved successfully
+ *    { type: "LOCATION_REQUEST", message: "Location retrieved successfully", data: { controlId: "id", location: "lat,lng", coordinates: { lat: 0, lng: 0 } } }
+ *
+ * 9. GET_ATTACHMENT - Request missing attachments from middleware
+ *    { type: "GET_ATTACHMENT", message: "Requesting missing attachments from middleware", data: { missingFiles: [{fileId: "id", field: "fieldName"}] } }
+ *
+ * ERROR EVENTS:
+ *
+ * 1. ERROR Code 001 - Invalid formsData JSON
+ *    { type: "ERROR", errorMessage: "ErrorCode : 001, Invalid formsData JSON", data: { error: e } }
+ *
+ * 2. ERROR Code 002 - Nested form validation error
+ *    { type: "ERROR", errorMessage: "ErrorCode : 002, Nested form validation error", data: { technicalError: nestedFormError } }
+ *
+ * 3. ERROR Code 003 - Master data validation error
+ *    { type: "ERROR", errorMessage: "ErrorCode : 003, Master data validation error", data: { technicalError: masterdataError } }
+ *
+ * 4. ERROR Code 004 - User Data not Provided
+ *    { type: "ERROR", errorMessage: "ErrorCode : 004, User Data not Provided", data: { reason: "User Data not Provided" } }
+ *
+ * 5. ERROR Code 005 - Formio not rendered the forms
+ *    { type: "ERROR", errorMessage: "ErrorCode : 005, Formio not rendered the forms", data: { technicalError: error } }
+ *
+ * 6. ERROR Code 006 - Formio not submit the form
+ *    { type: "ERROR", errorMessage: "ErrorCode : 006, Formio not submit the form", data: { formData: currentData, completeFlag, completionPercentage, technicalError: error } }
+ *
+ * 8. ERROR Code 008 - Location permission denied
+ *    { type: "ERROR", errorMessage: "ErrorCode : 008, Location permission denied", data: { technicalError: error, reason: "Location permission denied" } }
+ *
+ * 9. ERROR Code 009 - Location unavailable
+ *    { type: "ERROR", errorMessage: "ErrorCode : 009, Location unavailable", data: { technicalError: error, reason: "Location unavailable" } }
+ *
+ * 10. ERROR Code 010 - Location request timeout
+ *    { type: "ERROR", errorMessage: "ErrorCode : 010, Location request timeout", data: { technicalError: error, reason: "Location timeout" } }
+ *
+ * 11. ERROR Code 011 - Location unknown error
+ *    { type: "ERROR", errorMessage: "ErrorCode : 011, Location unknown error", data: { technicalError: error, reason: "Location unknown error" } }
+ *
+ * 12. ERROR Code 012 - Camera access error
+ *    { type: "ERROR", errorMessage: "ErrorCode : 012, Camera access error", data: { technicalError: error, reason: "Camera access error" } }
+ *
+ * 13. ERROR Code 013 - Attachments missing from storage
+ *    { type: "ERROR", errorMessage: "ErrorCode : 013, Attachments missing from storage", data: { reason: "Some attachments are missing from storage", missingFiles: [] } }
+ *
+ * 14. ERROR Code 014 - Failed to validate attachments
+ *    { type: "ERROR", errorMessage: "ErrorCode : 014, Failed to validate attachments", data: { reason: "Failed to validate attachments", technicalError: error } }
+ *
+ * 15. ERROR Code 015 - File not found in IndexedDB during processing
+ *    { type: "ERROR", errorMessage: "ErrorCode : 015, File not found in IndexedDB during processing", data: { reason: "File not found in IndexedDB: fileId", fileId: "id", field: "fieldName" } }
+ *
+ * 16. ERROR Code 016 - Formio library not loaded
+ *    { type: "ERROR", errorMessage: "ErrorCode : 016, Formio library not loaded", data: { reason: "Formio library not loaded" } }
+ *
+ * 17. ERROR Code 017 - Document not found
+ *    { type: "ERROR", errorMessage: "ErrorCode : 017, Document not found", data: { reason: "Document not found" } }
+ *
+ * 18. ERROR Code 018 - Invalid file format
+ *    { type: "ERROR", errorMessage: "ErrorCode : 018, Invalid file format", data: { reason: "Invalid file format" } }
+ *
+ * 19. ERROR Code 019 - File is corrupted (invalid base64)
+ *    { type: "ERROR", errorMessage: "ErrorCode : 019, File is corrupted (invalid base64)", data: { reason: "File is corrupted (invalid base64)" } }
+ *
+ * 20. ERROR Code 020 - File is empty
+ *    { type: "ERROR", errorMessage: "ErrorCode : 020, File is empty", data: { reason: "File is empty" } }
+ *
+ * 21. ERROR Code 021 - File is corrupted (invalid encoding)
+ *    { type: "ERROR", errorMessage: "ErrorCode : 021, File is corrupted (invalid encoding)", data: { reason: "File is corrupted (invalid encoding)", technicalError: error } }
+ *
+ * 22. ERROR Code 022 - Failed to process file
+ *    { type: "ERROR", errorMessage: "ErrorCode : 022, Failed to process file", data: { reason: "Failed to process file", technicalError: error } }
+ *
+ * 23. ERROR Code 023 - File is empty
+ *    { type: "ERROR", errorMessage: "ErrorCode : 023, File is empty", data: { reason: "File is empty" } }
+ *
+ * 24. ERROR Code 024 - No downloadable content found
+ *    { type: "ERROR", errorMessage: "ErrorCode : 024, No downloadable content found", data: { reason: "No downloadable content found" } }
+ *
+ * 25. ERROR Code 025 - Failed to load documents
+ *    { type: "ERROR", errorMessage: "ErrorCode : 025, Failed to load documents", data: { reason: "Failed to load documents", technicalError: error } }
+ *
+
+ */