@capawesome/capacitor-pdf-generator 0.0.1

package/dist/docs.json

@@ -0,0 +1,401 @@
+{
+  "api": {
+    "name": "PdfGeneratorPlugin",
+    "slug": "pdfgeneratorplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "generateFromHtml",
+        "signature": "(options: GenerateFromHtmlOptions) => Promise<GenerateResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GenerateFromHtmlOptions"
+          }
+        ],
+        "returns": "Promise<GenerateResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Generate a paginated PDF file from an HTML string.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GenerateResult",
+          "GenerateFromHtmlOptions"
+        ],
+        "slug": "generatefromhtml"
+      },
+      {
+        "name": "generateFromUrl",
+        "signature": "(options: GenerateFromUrlOptions) => Promise<GenerateResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GenerateFromUrlOptions"
+          }
+        ],
+        "returns": "Promise<GenerateResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Generate a paginated PDF file from a URL.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GenerateResult",
+          "GenerateFromUrlOptions"
+        ],
+        "slug": "generatefromurl"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "GenerateResult",
+      "slug": "generateresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "path",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'file:///data/user/0/dev.robingenz.capacitor.plugindemo/cache/capawesome_capacitor_pdf_generator_documents/invoice.pdf'",
+              "name": "example"
+            }
+          ],
+          "docs": "The path of the generated PDF file.\n\nThe file is stored in the cache directory and deleted on the next app\nlaunch. Move it to a permanent location if you want to keep it.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GenerateFromHtmlOptions",
+      "slug": "generatefromhtmloptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "baseUrl",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'https://capawesome.io/'",
+              "name": "example"
+            }
+          ],
+          "docs": "The base URL to resolve relative resources (e.g. images, stylesheets)\nin the HTML content against.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fileName",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "A randomly generated file name.",
+              "name": "default"
+            },
+            {
+              "text": "'invoice.pdf'",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the generated PDF file.\n\nIf the name does not end with `.pdf`, the extension is appended.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "html",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'<h1>Hello World</h1>'",
+              "name": "example"
+            }
+          ],
+          "docs": "The HTML content to generate the PDF file from.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "orientation",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "Orientation.Portrait",
+              "name": "default"
+            }
+          ],
+          "docs": "The page orientation of the generated PDF file.",
+          "complexTypes": [
+            "Orientation"
+          ],
+          "type": "Orientation"
+        },
+        {
+          "name": "pageSize",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "PageSize.A4",
+              "name": "default"
+            }
+          ],
+          "docs": "The page size of the generated PDF file.",
+          "complexTypes": [
+            "PageSize"
+          ],
+          "type": "PageSize"
+        },
+        {
+          "name": "timeout",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "30000",
+              "name": "default"
+            },
+            {
+              "text": "10000",
+              "name": "example"
+            }
+          ],
+          "docs": "The maximum time in milliseconds to wait for the PDF generation\nto complete before the call is rejected with the `TIMEOUT` error code.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GenerateFromUrlOptions",
+      "slug": "generatefromurloptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "fileName",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "A randomly generated file name.",
+              "name": "default"
+            },
+            {
+              "text": "'invoice.pdf'",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the generated PDF file.\n\nIf the name does not end with `.pdf`, the extension is appended.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "orientation",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "Orientation.Portrait",
+              "name": "default"
+            }
+          ],
+          "docs": "The page orientation of the generated PDF file.",
+          "complexTypes": [
+            "Orientation"
+          ],
+          "type": "Orientation"
+        },
+        {
+          "name": "pageSize",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "PageSize.A4",
+              "name": "default"
+            }
+          ],
+          "docs": "The page size of the generated PDF file.",
+          "complexTypes": [
+            "PageSize"
+          ],
+          "type": "PageSize"
+        },
+        {
+          "name": "timeout",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "30000",
+              "name": "default"
+            },
+            {
+              "text": "10000",
+              "name": "example"
+            }
+          ],
+          "docs": "The maximum time in milliseconds to wait for the PDF generation\nto complete before the call is rejected with the `TIMEOUT` error code.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "url",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'https://capawesome.io/'",
+              "name": "example"
+            }
+          ],
+          "docs": "The URL of the web page to generate the PDF file from.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "Orientation",
+      "slug": "orientation",
+      "members": [
+        {
+          "name": "Landscape",
+          "value": "'LANDSCAPE'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Landscape orientation."
+        },
+        {
+          "name": "Portrait",
+          "value": "'PORTRAIT'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Portrait orientation."
+        }
+      ]
+    },
+    {
+      "name": "PageSize",
+      "slug": "pagesize",
+      "members": [
+        {
+          "name": "A3",
+          "value": "'A3'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "ISO A3 (297 x 420 mm)."
+        },
+        {
+          "name": "A4",
+          "value": "'A4'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "ISO A4 (210 x 297 mm)."
+        },
+        {
+          "name": "A5",
+          "value": "'A5'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "ISO A5 (148 x 210 mm)."
+        },
+        {
+          "name": "Letter",
+          "value": "'LETTER'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "US Letter (8.5 x 11 in)."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,204 @@
+export interface PdfGeneratorPlugin {
+    /**
+     * Generate a paginated PDF file from an HTML string.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    generateFromHtml(options: GenerateFromHtmlOptions): Promise<GenerateResult>;
+    /**
+     * Generate a paginated PDF file from a URL.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    generateFromUrl(options: GenerateFromUrlOptions): Promise<GenerateResult>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface GenerateFromHtmlOptions {
+    /**
+     * The base URL to resolve relative resources (e.g. images, stylesheets)
+     * in the HTML content against.
+     *
+     * @since 0.1.0
+     * @example 'https://capawesome.io/'
+     */
+    baseUrl?: string;
+    /**
+     * The name of the generated PDF file.
+     *
+     * If the name does not end with `.pdf`, the extension is appended.
+     *
+     * @since 0.1.0
+     * @default A randomly generated file name.
+     * @example 'invoice.pdf'
+     */
+    fileName?: string;
+    /**
+     * The HTML content to generate the PDF file from.
+     *
+     * @since 0.1.0
+     * @example '<h1>Hello World</h1>'
+     */
+    html: string;
+    /**
+     * The page orientation of the generated PDF file.
+     *
+     * @since 0.1.0
+     * @default Orientation.Portrait
+     */
+    orientation?: Orientation;
+    /**
+     * The page size of the generated PDF file.
+     *
+     * @since 0.1.0
+     * @default PageSize.A4
+     */
+    pageSize?: PageSize;
+    /**
+     * The maximum time in milliseconds to wait for the PDF generation
+     * to complete before the call is rejected with the `TIMEOUT` error code.
+     *
+     * @since 0.1.0
+     * @default 30000
+     * @example 10000
+     */
+    timeout?: number;
+}
+/**
+ * @since 0.1.0
+ */
+export interface GenerateFromUrlOptions {
+    /**
+     * The name of the generated PDF file.
+     *
+     * If the name does not end with `.pdf`, the extension is appended.
+     *
+     * @since 0.1.0
+     * @default A randomly generated file name.
+     * @example 'invoice.pdf'
+     */
+    fileName?: string;
+    /**
+     * The page orientation of the generated PDF file.
+     *
+     * @since 0.1.0
+     * @default Orientation.Portrait
+     */
+    orientation?: Orientation;
+    /**
+     * The page size of the generated PDF file.
+     *
+     * @since 0.1.0
+     * @default PageSize.A4
+     */
+    pageSize?: PageSize;
+    /**
+     * The maximum time in milliseconds to wait for the PDF generation
+     * to complete before the call is rejected with the `TIMEOUT` error code.
+     *
+     * @since 0.1.0
+     * @default 30000
+     * @example 10000
+     */
+    timeout?: number;
+    /**
+     * The URL of the web page to generate the PDF file from.
+     *
+     * @since 0.1.0
+     * @example 'https://capawesome.io/'
+     */
+    url: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface GenerateResult {
+    /**
+     * The path of the generated PDF file.
+     *
+     * The file is stored in the cache directory and deleted on the next app
+     * launch. Move it to a permanent location if you want to keep it.
+     *
+     * @since 0.1.0
+     * @example 'file:///data/user/0/dev.robingenz.capacitor.plugindemo/cache/capawesome_capacitor_pdf_generator_documents/invoice.pdf'
+     */
+    path: string;
+}
+/**
+ * The page orientation of the generated PDF file.
+ *
+ * @since 0.1.0
+ */
+export declare enum Orientation {
+    /**
+     * Landscape orientation.
+     *
+     * @since 0.1.0
+     */
+    Landscape = "LANDSCAPE",
+    /**
+     * Portrait orientation.
+     *
+     * @since 0.1.0
+     */
+    Portrait = "PORTRAIT"
+}
+/**
+ * The page size of the generated PDF file.
+ *
+ * @since 0.1.0
+ */
+export declare enum PageSize {
+    /**
+     * ISO A3 (297 x 420 mm).
+     *
+     * @since 0.1.0
+     */
+    A3 = "A3",
+    /**
+     * ISO A4 (210 x 297 mm).
+     *
+     * @since 0.1.0
+     */
+    A4 = "A4",
+    /**
+     * ISO A5 (148 x 210 mm).
+     *
+     * @since 0.1.0
+     */
+    A5 = "A5",
+    /**
+     * US Letter (8.5 x 11 in).
+     *
+     * @since 0.1.0
+     */
+    Letter = "LETTER"
+}
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * The PDF file could not be generated.
+     *
+     * @since 0.1.0
+     */
+    GenerationFailed = "GENERATION_FAILED",
+    /**
+     * The HTML content or URL could not be loaded.
+     *
+     * @since 0.1.0
+     */
+    LoadFailed = "LOAD_FAILED",
+    /**
+     * The PDF generation timed out.
+     *
+     * @since 0.1.0
+     */
+    Timeout = "TIMEOUT"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,77 @@
+/**
+ * The page orientation of the generated PDF file.
+ *
+ * @since 0.1.0
+ */
+export var Orientation;
+(function (Orientation) {
+    /**
+     * Landscape orientation.
+     *
+     * @since 0.1.0
+     */
+    Orientation["Landscape"] = "LANDSCAPE";
+    /**
+     * Portrait orientation.
+     *
+     * @since 0.1.0
+     */
+    Orientation["Portrait"] = "PORTRAIT";
+})(Orientation || (Orientation = {}));
+/**
+ * The page size of the generated PDF file.
+ *
+ * @since 0.1.0
+ */
+export var PageSize;
+(function (PageSize) {
+    /**
+     * ISO A3 (297 x 420 mm).
+     *
+     * @since 0.1.0
+     */
+    PageSize["A3"] = "A3";
+    /**
+     * ISO A4 (210 x 297 mm).
+     *
+     * @since 0.1.0
+     */
+    PageSize["A4"] = "A4";
+    /**
+     * ISO A5 (148 x 210 mm).
+     *
+     * @since 0.1.0
+     */
+    PageSize["A5"] = "A5";
+    /**
+     * US Letter (8.5 x 11 in).
+     *
+     * @since 0.1.0
+     */
+    PageSize["Letter"] = "LETTER";
+})(PageSize || (PageSize = {}));
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * The PDF file could not be generated.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["GenerationFailed"] = "GENERATION_FAILED";
+    /**
+     * The HTML content or URL could not be loaded.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["LoadFailed"] = "LOAD_FAILED";
+    /**
+     * The PDF generation timed out.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["Timeout"] = "TIMEOUT";
+})(ErrorCode || (ErrorCode = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAuIA;;;;GAIG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,sCAAuB,CAAA;IACvB;;;;OAIG;IACH,oCAAqB,CAAA;AACvB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,QAyBX;AAzBD,WAAY,QAAQ;IAClB;;;;OAIG;IACH,qBAAS,CAAA;IACT;;;;OAIG;IACH,qBAAS,CAAA;IACT;;;;OAIG;IACH,qBAAS,CAAA;IACT;;;;OAIG;IACH,6BAAiB,CAAA;AACnB,CAAC,EAzBW,QAAQ,KAAR,QAAQ,QAyBnB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAmBX;AAnBD,WAAY,SAAS;IACnB;;;;OAIG;IACH,mDAAsC,CAAA;IACtC;;;;OAIG;IACH,uCAA0B,CAAA;IAC1B;;;;OAIG;IACH,gCAAmB,CAAA;AACrB,CAAC,EAnBW,SAAS,KAAT,SAAS,QAmBpB","sourcesContent":["export interface PdfGeneratorPlugin {\n  /**\n   * Generate a paginated PDF file from an HTML string.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  generateFromHtml(options: GenerateFromHtmlOptions): Promise<GenerateResult>;\n  /**\n   * Generate a paginated PDF file from a URL.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  generateFromUrl(options: GenerateFromUrlOptions): Promise<GenerateResult>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface GenerateFromHtmlOptions {\n  /**\n   * The base URL to resolve relative resources (e.g. images, stylesheets)\n   * in the HTML content against.\n   *\n   * @since 0.1.0\n   * @example 'https://capawesome.io/'\n   */\n  baseUrl?: string;\n  /**\n   * The name of the generated PDF file.\n   *\n   * If the name does not end with `.pdf`, the extension is appended.\n   *\n   * @since 0.1.0\n   * @default A randomly generated file name.\n   * @example 'invoice.pdf'\n   */\n  fileName?: string;\n  /**\n   * The HTML content to generate the PDF file from.\n   *\n   * @since 0.1.0\n   * @example '<h1>Hello World</h1>'\n   */\n  html: string;\n  /**\n   * The page orientation of the generated PDF file.\n   *\n   * @since 0.1.0\n   * @default Orientation.Portrait\n   */\n  orientation?: Orientation;\n  /**\n   * The page size of the generated PDF file.\n   *\n   * @since 0.1.0\n   * @default PageSize.A4\n   */\n  pageSize?: PageSize;\n  /**\n   * The maximum time in milliseconds to wait for the PDF generation\n   * to complete before the call is rejected with the `TIMEOUT` error code.\n   *\n   * @since 0.1.0\n   * @default 30000\n   * @example 10000\n   */\n  timeout?: number;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface GenerateFromUrlOptions {\n  /**\n   * The name of the generated PDF file.\n   *\n   * If the name does not end with `.pdf`, the extension is appended.\n   *\n   * @since 0.1.0\n   * @default A randomly generated file name.\n   * @example 'invoice.pdf'\n   */\n  fileName?: string;\n  /**\n   * The page orientation of the generated PDF file.\n   *\n   * @since 0.1.0\n   * @default Orientation.Portrait\n   */\n  orientation?: Orientation;\n  /**\n   * The page size of the generated PDF file.\n   *\n   * @since 0.1.0\n   * @default PageSize.A4\n   */\n  pageSize?: PageSize;\n  /**\n   * The maximum time in milliseconds to wait for the PDF generation\n   * to complete before the call is rejected with the `TIMEOUT` error code.\n   *\n   * @since 0.1.0\n   * @default 30000\n   * @example 10000\n   */\n  timeout?: number;\n  /**\n   * The URL of the web page to generate the PDF file from.\n   *\n   * @since 0.1.0\n   * @example 'https://capawesome.io/'\n   */\n  url: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface GenerateResult {\n  /**\n   * The path of the generated PDF file.\n   *\n   * The file is stored in the cache directory and deleted on the next app\n   * launch. Move it to a permanent location if you want to keep it.\n   *\n   * @since 0.1.0\n   * @example 'file:///data/user/0/dev.robingenz.capacitor.plugindemo/cache/capawesome_capacitor_pdf_generator_documents/invoice.pdf'\n   */\n  path: string;\n}\n\n/**\n * The page orientation of the generated PDF file.\n *\n * @since 0.1.0\n */\nexport enum Orientation {\n  /**\n   * Landscape orientation.\n   *\n   * @since 0.1.0\n   */\n  Landscape = 'LANDSCAPE',\n  /**\n   * Portrait orientation.\n   *\n   * @since 0.1.0\n   */\n  Portrait = 'PORTRAIT',\n}\n\n/**\n * The page size of the generated PDF file.\n *\n * @since 0.1.0\n */\nexport enum PageSize {\n  /**\n   * ISO A3 (297 x 420 mm).\n   *\n   * @since 0.1.0\n   */\n  A3 = 'A3',\n  /**\n   * ISO A4 (210 x 297 mm).\n   *\n   * @since 0.1.0\n   */\n  A4 = 'A4',\n  /**\n   * ISO A5 (148 x 210 mm).\n   *\n   * @since 0.1.0\n   */\n  A5 = 'A5',\n  /**\n   * US Letter (8.5 x 11 in).\n   *\n   * @since 0.1.0\n   */\n  Letter = 'LETTER',\n}\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * The PDF file could not be generated.\n   *\n   * @since 0.1.0\n   */\n  GenerationFailed = 'GENERATION_FAILED',\n  /**\n   * The HTML content or URL could not be loaded.\n   *\n   * @since 0.1.0\n   */\n  LoadFailed = 'LOAD_FAILED',\n  /**\n   * The PDF generation timed out.\n   *\n   * @since 0.1.0\n   */\n  Timeout = 'TIMEOUT',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { PdfGeneratorPlugin } from './definitions';
+declare const PdfGenerator: PdfGeneratorPlugin;
+export * from './definitions';
+export { PdfGenerator };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const PdfGenerator = registerPlugin('PdfGenerator', {
+    web: () => import('./web').then(m => new m.PdfGeneratorWeb()),
+});
+export * from './definitions';
+export { PdfGenerator };
+//# sourceMappingURL=index.js.map