@capgo/capacitor-printer 7.0.0

package/dist/docs.json

@@ -0,0 +1,520 @@
+{
+  "api": {
+    "name": "PrinterPlugin",
+    "slug": "printerplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "printBase64",
+        "signature": "(options: PrintBase64Options) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The base64 data and configuration for printing",
+            "type": "PrintBase64Options"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The base64 data and configuration for printing"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when print dialog is dismissed"
+          },
+          {
+            "name": "throws",
+            "text": "Error if base64 data is invalid or printing fails"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Print a base64 encoded PDF\nawait Printer.printBase64({\n  name: 'Invoice #12345',\n  data: 'JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL...',\n  mimeType: 'application/pdf',\n});\n\n// Print a base64 encoded image\nawait Printer.printBase64({\n  name: 'Product Photo',\n  data: '/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDA...',\n  mimeType: 'image/jpeg',\n});\n```"
+          }
+        ],
+        "docs": "Presents the printing UI to print files encoded as base64 strings.\n\n**Platform Behavior:**\n- **iOS**: Uses UIPrintInteractionController with base64 decoded data\n- **Android**: Uses PrintManager with base64 decoded data\n- **Web**: Creates a blob from base64 data and opens print dialog\n\n**Performance Warning:**\nLarge files can lead to app crashes due to memory constraints when decoding base64.\nFor files larger than 5MB, it's recommended to use printFile() instead.",
+        "complexTypes": [
+          "PrintBase64Options"
+        ],
+        "slug": "printbase64"
+      },
+      {
+        "name": "printFile",
+        "signature": "(options: PrintFileOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The file path and configuration for printing",
+            "type": "PrintFileOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The file path and configuration for printing"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when print dialog is dismissed"
+          },
+          {
+            "name": "throws",
+            "text": "Error if file path is invalid, file not found, or unsupported file type"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// iOS: Print from app documents directory\nawait Printer.printFile({\n  name: 'Contract',\n  path: 'file:///var/mobile/Containers/Data/Application/.../Documents/contract.pdf',\n});\n\n// Android: Print from content URI\nawait Printer.printFile({\n  name: 'Receipt',\n  path: 'content://com.android.providers.downloads.documents/document/123',\n  mimeType: 'application/pdf',\n});\n\n// Android: Print from file path\nawait Printer.printFile({\n  name: 'Photo',\n  path: 'file:///storage/emulated/0/Download/photo.jpg',\n  mimeType: 'image/jpeg',\n});\n```"
+          }
+        ],
+        "docs": "Presents the printing UI to print device files.\n\n**Platform Behavior:**\n- **iOS**: Uses UIPrintInteractionController with file URL. Supports file:// paths or paths relative to app's documents directory.\n- **Android**: Uses PrintManager with file path. Supports both content:// URIs and file:// paths.\n- **Web**: Reads file and opens print dialog\n\n**Supported File Types:**\n- PDF documents (application/pdf)\n- Images: JPEG, PNG, GIF, HEIC, HEIF",
+        "complexTypes": [
+          "PrintFileOptions"
+        ],
+        "slug": "printfile"
+      },
+      {
+        "name": "printHtml",
+        "signature": "(options: PrintHtmlOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The HTML content and configuration for printing",
+            "type": "PrintHtmlOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The HTML content and configuration for printing"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when print dialog is dismissed"
+          },
+          {
+            "name": "throws",
+            "text": "Error if HTML is invalid or printing fails"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Simple HTML document\nawait Printer.printHtml({\n  name: 'Sales Report',\n  html: '<html><body><h1>Q4 Sales Report</h1><p>Revenue: $125,000</p></body></html>',\n});\n\n// HTML with print-specific CSS\nawait Printer.printHtml({\n  name: 'Styled Invoice',\n  html: `\n    <html>\n      <head>\n        <style>"
+          },
+          {
+            "name": "media",
+            "text": "print {\n     body { font-size: 12pt; }\n     .no-print { display: none; }\n     h1 { page-break-before: always; }\n   }\n </style>\n</head>\n<body>\n <h1>Invoice #12345</h1>\n <p>Amount due: $299.99</p>\n <button class=\"no-print\">Don't print this button</button>\n</body>\n</html>\n`,\n});\n```"
+          }
+        ],
+        "docs": "Presents the printing UI to print HTML documents.\n\n**Platform Behavior:**\n- **iOS**: Renders HTML in WKWebView, then prints using UIPrintInteractionController\n- **Android**: Renders HTML in WebView, then prints using PrintManager\n- **Web**: Creates iframe with HTML content and triggers print dialog\n\n**HTML Requirements:**\n- Should be a complete HTML document with proper structure\n- Can include inline CSS styles or style tags\n- External resources (images, stylesheets) should use absolute URLs\n- Print-specific CSS can be added using @media print rules\n\n**CSS Print Styling:**\nUse CSS media queries to customize print output:\n- Control page breaks: page-break-before, page-break-after, page-break-inside\n- Hide elements: display: none for no-print classes\n- Adjust font sizes and colors for print",
+        "complexTypes": [
+          "PrintHtmlOptions"
+        ],
+        "slug": "printhtml"
+      },
+      {
+        "name": "printPdf",
+        "signature": "(options: PrintPdfOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- The PDF file path and configuration for printing",
+            "type": "PrintPdfOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - The PDF file path and configuration for printing"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when print dialog is dismissed"
+          },
+          {
+            "name": "throws",
+            "text": "Error if PDF path is invalid, file not found, or not a valid PDF"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Print PDF from app storage\nawait Printer.printPdf({\n  name: 'Annual Report 2024',\n  path: 'file:///var/mobile/Containers/Data/Application/.../Documents/report.pdf',\n});\n\n// Print PDF from Android downloads\nawait Printer.printPdf({\n  name: 'Downloaded Document',\n  path: 'content://com.android.providers.downloads.documents/document/123',\n});\n```"
+          }
+        ],
+        "docs": "Presents the printing UI to print PDF documents.\n\n**Platform Behavior:**\n- **iOS**: Uses UIPrintInteractionController with PDF file URL\n- **Android**: Uses PrintManager with PdfDocument\n- **Web**: Creates object URL and opens print dialog\n\n**File Path Requirements:**\n- **iOS**: Must be file:// path or relative to app's documents directory\n- **Android**: Supports content:// URIs (from downloads, media store) or file:// paths\n- **Web**: Must be accessible file path",
+        "complexTypes": [
+          "PrintPdfOptions"
+        ],
+        "slug": "printpdf"
+      },
+      {
+        "name": "printWebView",
+        "signature": "(options?: PrintOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Optional configuration for printing (name only)",
+            "type": "PrintOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options - Optional configuration for printing (name only)"
+          },
+          {
+            "name": "returns",
+            "text": "Promise that resolves when print dialog is dismissed"
+          },
+          {
+            "name": "throws",
+            "text": "Error if web view is not available or printing fails"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\n// Print current web view with default name\nawait Printer.printWebView();\n\n// Print with custom job name\nawait Printer.printWebView({\n  name: 'Dashboard Screenshot',\n});\n\n// Use with print-specific CSS in your HTML\n// Add this to your app's CSS:\n//"
+          },
+          {
+            "name": "media",
+            "text": "print {\n//   .no-print { display: none; }\n//   body { font-size: 12pt; }\n// }\nawait Printer.printWebView({\nname: 'User Profile',\n});\n```"
+          }
+        ],
+        "docs": "Presents the printing UI to print web view content.\n\nPrints the current content displayed in your app's web view.\n\n**Platform Behavior:**\n- **iOS**: Uses UIPrintInteractionController with WKWebView's view printable\n- **Android**: Uses WebView.createPrintDocumentAdapter() with PrintManager\n- **Web**: Triggers window.print() for current page\n\n**Print Styling:**\nSupports CSS print media queries for customization. The web view's current\nstyles will be applied, including any @media print rules.\n\n**Use Cases:**\n- Print the current app screen/page\n- Print web-based reports or dashboards\n- Print user-generated content displayed in web view",
+        "complexTypes": [
+          "PrintOptions"
+        ],
+        "slug": "printwebview"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<{ version: string; }>",
+        "parameters": [],
+        "returns": "Promise<{ version: string; }>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Promise that resolves with the plugin version string"
+          },
+          {
+            "name": "throws",
+            "text": "Error if getting the version fails"
+          },
+          {
+            "name": "since",
+            "text": "7.0.0"
+          },
+          {
+            "name": "example",
+            "text": "```typescript\nconst { version } = await Printer.getPluginVersion();\nconsole.log('Printer plugin version:', version);\n// Output: \"7.0.0\"\n```"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.\n\nReturns the hardcoded plugin version from native code (iOS/Android) or\npackage version (Web). This is useful for debugging and ensuring plugin\ncompatibility.",
+        "complexTypes": [],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PrintBase64Options",
+      "slug": "printbase64options",
+      "docs": "Options for printing base64 encoded data.",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL...'",
+              "name": "example"
+            }
+          ],
+          "docs": "Valid base64 encoded string representing the file content.\n\nThe base64 string should NOT include the data URL prefix (e.g., \"data:application/pdf;base64,\").\nOnly provide the raw base64 encoded content.\n\n**Performance Considerations:**\n- Base64 encoding increases data size by approximately 33%\n- Large files (>5MB) may cause memory issues when decoding\n- Consider using printFile() for large documents\n\n**Platform Notes:**\n- **iOS**: Decoded to NSData and passed to UIPrintInteractionController\n- **Android**: Decoded to byte array and written to temporary file\n- **Web**: Converted to Blob for printing",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "mimeType",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'application/pdf'",
+              "name": "example"
+            },
+            {
+              "text": "'image/jpeg'",
+              "name": "example"
+            }
+          ],
+          "docs": "MIME type of the base64 encoded data.\n\n**Supported types:**\n- `application/pdf` - PDF documents\n- `image/jpeg` - JPEG images\n- `image/png` - PNG images\n- `image/gif` - GIF images (iOS/Android only)\n- `image/heic` - HEIC images (iOS only)\n- `image/heif` - HEIF images (iOS only)\n\n**Platform Support:**\n- All platforms support PDF, JPEG, and PNG\n- GIF support varies by platform\n- HEIC/HEIF are iOS-specific formats",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PrintFileOptions",
+      "slug": "printfileoptions",
+      "docs": "Options for printing files from device storage.",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "ios Supports file:// paths and relative paths",
+              "name": "platform"
+            },
+            {
+              "text": "android Supports content:// URIs and file:// paths",
+              "name": "platform"
+            },
+            {
+              "text": "'content://com.android.providers.downloads.documents/document/123'",
+              "name": "example"
+            },
+            {
+              "text": "'file:///var/mobile/Containers/Data/Application/.../Documents/document.pdf'",
+              "name": "example"
+            },
+            {
+              "text": "'file:///storage/emulated/0/Download/receipt.pdf'",
+              "name": "example"
+            }
+          ],
+          "docs": "Path to the file to print.\n\n**iOS Path Formats:**\n- `file://` URL: Full file URL path\n- Relative path: Path relative to app's documents directory\n- Must be within app's accessible directories (documents, temporary, cache)\n\n**Android Path Formats:**\n- `content://` URI: Content provider URI (recommended for external files)\n- `file://` path: Direct file system path\n- Must have read permission for the file\n\n**Common Use Cases:**\n- App documents: Files saved in app's document directory\n- Downloads: Files from system downloads folder (use content:// on Android)\n- Temporary files: Files in app's temporary/cache directory\n- Shared storage: Files from external storage (Android, requires permissions)",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "mimeType",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "Undefined (auto-detected from file extension)",
+              "name": "default"
+            },
+            {
+              "text": "android Used for content:// URIs and file type detection",
+              "name": "platform"
+            },
+            {
+              "text": "ios Ignored (auto-detected)",
+              "name": "platform"
+            },
+            {
+              "text": "'application/pdf'",
+              "name": "example"
+            },
+            {
+              "text": "'image/jpeg'",
+              "name": "example"
+            }
+          ],
+          "docs": "MIME type of the file.\n\n**Platform Behavior:**\n- **Android**: REQUIRED for content:// URIs. Helps the system determine how to handle the file.\n               Optional for file:// paths (auto-detected from extension).\n- **iOS**: Ignored. File type is auto-detected from file extension.\n- **Web**: Optional. Auto-detected if not provided.\n\n**Common MIME Types:**\n- `application/pdf` - PDF documents\n- `image/jpeg` - JPEG images\n- `image/png` - PNG images\n- `image/gif` - GIF images",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PrintHtmlOptions",
+      "slug": "printhtmloptions",
+      "docs": "Options for printing HTML content.",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "html",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'<html><body><h1>Hello World</h1><p>This is a test document.</p></body></html>'",
+              "name": "example"
+            },
+            {
+              "text": "```typescript\nconst htmlWithStyles = `\n  <html>\n    <head>\n      <meta charset=\"UTF-8\">\n      <style>",
+              "name": "example"
+            },
+            {
+              "text": "print {\n   body { font-family: Arial, sans-serif; font-size: 12pt; }\n   .no-print { display: none; }\n   h1 { color: #333; page-break-before: always; }\n }\n</style>\n</head>\n<body>\n<h1>Invoice #12345</h1>\n<p>Amount: $299.99</p>\n</body>\n</html>\n`;\n```",
+              "name": "media"
+            }
+          ],
+          "docs": "HTML content to print.\n\n**Content Requirements:**\n- Should be a complete HTML document with `<html>`, `<head>`, and `<body>` tags\n- Can include inline CSS styles or `<style>` tags\n- External resources (images, fonts) should use absolute URLs\n- JavaScript is not executed during print rendering\n\n**Print Optimization Tips:**\n- Use `@media print` CSS rules for print-specific styling\n- Control page breaks with `page-break-before`, `page-break-after`, `page-break-inside`\n- Hide UI elements using `.no-print { display: none; }` class\n- Adjust font sizes for readability (12pt is standard for print)\n- Use print-friendly colors (avoid dark backgrounds)\n\n**Platform Rendering:**\n- **iOS**: Rendered in WKWebView before printing\n- **Android**: Rendered in WebView before printing\n- **Web**: Rendered in hidden iframe before printing\n\n**Character Encoding:**\n- UTF-8 is recommended and default\n- Include charset in HTML: `<meta charset=\"UTF-8\">`",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PrintPdfOptions",
+      "slug": "printpdfoptions",
+      "docs": "Options for printing PDF documents.",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "ios Supports file:// paths and relative paths",
+              "name": "platform"
+            },
+            {
+              "text": "android Supports content:// URIs and file:// paths",
+              "name": "platform"
+            },
+            {
+              "text": "web Supports accessible file paths",
+              "name": "platform"
+            },
+            {
+              "text": "'content://com.android.providers.downloads.documents/document/123'",
+              "name": "example"
+            },
+            {
+              "text": "'file:///var/mobile/Containers/Data/Application/.../Documents/document.pdf'",
+              "name": "example"
+            },
+            {
+              "text": "'file:///storage/emulated/0/Download/report.pdf'",
+              "name": "example"
+            },
+            {
+              "text": "'Documents/invoice-2024.pdf'",
+              "name": "example"
+            }
+          ],
+          "docs": "Path to the PDF document.\n\n**iOS Path Formats:**\n- `file://` URL: Full file URL path to PDF document\n- Relative path: Path relative to app's documents directory\n- Must be within app's accessible directories (documents, temporary, cache)\n- PDF must be valid and not password-protected\n\n**Android Path Formats:**\n- `content://` URI: Content provider URI (recommended for external PDFs)\n- `file://` path: Direct file system path to PDF\n- Must have read permission for the file\n- Supports both single-page and multi-page PDFs\n\n**Web Path Formats:**\n- Relative or absolute path accessible from web context\n- Must be a valid PDF file\n\n**Validation:**\n- File must exist at the specified path\n- File must be a valid PDF (checked by magic number/header)\n- File must be readable by the app\n\n**Common Sources:**\n- App documents: PDFs saved in app's document directory\n- Downloads: PDFs from system downloads (use content:// on Android)\n- Generated PDFs: Temporary PDFs created by the app\n- Network downloads: PDFs downloaded and saved locally",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PrintOptions",
+      "slug": "printoptions",
+      "docs": "Base options for all print operations.",
+      "tags": [
+        {
+          "text": "7.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "7.0.0",
+              "name": "since"
+            },
+            {
+              "text": "'Document'",
+              "name": "default"
+            },
+            {
+              "text": "ios Shown in print preview and activity view",
+              "name": "platform"
+            },
+            {
+              "text": "android Shown in print queue and notifications",
+              "name": "platform"
+            },
+            {
+              "text": "web Used as document title in print dialog",
+              "name": "platform"
+            },
+            {
+              "text": "'Invoice #12345'",
+              "name": "example"
+            },
+            {
+              "text": "'Annual Report 2024'",
+              "name": "example"
+            },
+            {
+              "text": "'Receipt - Order #789'",
+              "name": "example"
+            }
+          ],
+          "docs": "Name of the print job.\n\n**Usage:**\n- Displayed in the system print queue\n- Shown in print history/logs\n- May appear in printer status displays\n- Used as default filename for \"Save as PDF\" option\n\n**Platform Behavior:**\n- **iOS**: Shown in print preview header and activity view\n- **Android**: Displayed in print job notification and print queue\n- **Web**: Used as document title in print dialog\n\n**Best Practices:**\n- Use descriptive names (e.g., \"Invoice #12345\", \"Q4 Report\")\n- Keep under 50 characters for better display\n- Avoid special characters that may cause issues in filenames\n- Include relevant identifiers (order numbers, dates, etc.)\n\n**Examples:**\n- \"Invoice #12345\"\n- \"Sales Report - 2024 Q4\"\n- \"Customer Receipt - John Doe\"\n- \"Product Photo - SKU-ABC123\"",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}