npm - @capgo/capacitor-pdf-generator - Versions diffs - 7.0.0 - Mend

@capgo/capacitor-pdf-generator 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

package/CapgoCapacitorPdfGenerator.podspec +17 -0
package/LICENSE +21 -0
package/Package.swift +28 -0
package/README.md +112 -0
package/android/build.gradle +57 -0
package/android/src/main/AndroidManifest.xml +13 -0
package/android/src/main/java/android/print/CapgoPdfPrintUtils.java +210 -0
package/android/src/main/java/app/capgo/pdfgenerator/PdfGeneratorPlugin.java +381 -0
package/android/src/main/res/.gitkeep +0 -0
package/android/src/main/res/xml/capgo_pdf_generator_paths.xml +6 -0
package/dist/docs.json +109 -0
package/dist/esm/definitions.d.ts +56 -0
package/dist/esm/definitions.js +2 -0
package/dist/esm/definitions.js.map +1 -0
package/dist/esm/index.d.ts +4 -0
package/dist/esm/index.js +7 -0
package/dist/esm/index.js.map +1 -0
package/dist/esm/web.d.ts +6 -0
package/dist/esm/web.js +10 -0
package/dist/esm/web.js.map +1 -0
package/dist/plugin.cjs.js +24 -0
package/dist/plugin.cjs.js.map +1 -0
package/dist/plugin.js +27 -0
package/dist/plugin.js.map +1 -0
package/ios/Sources/PdfGeneratorPlugin/PdfGeneratorPlugin.swift +292 -0
package/ios/Tests/PdfGeneratorPluginTests/PdfGeneratorPluginTests.swift +7 -0
package/package.json +86 -0

package/CapgoCapacitorPdfGenerator.podspec ADDED Viewed

@@ -0,0 +1,17 @@
+require 'json'
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+Pod::Spec.new do |s|
+  s.name = 'CapgoCapacitorPdfGenerator'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target = '14.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+end

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2022 Capgo
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Package.swift ADDED Viewed

@@ -0,0 +1,28 @@
+// swift-tools-version: 5.9
+import PackageDescription
+let package = Package(
+    name: "CapgoCapacitorPdfGenerator",
+    platforms: [.iOS(.v14)],
+    products: [
+        .library(
+            name: "CapgoCapacitorPdfGenerator",
+            targets: ["PdfGeneratorPlugin"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0")
+    ],
+    targets: [
+        .target(
+            name: "PdfGeneratorPlugin",
+            dependencies: [
+                .product(name: "Capacitor", package: "capacitor-swift-pm"),
+                .product(name: "Cordova", package: "capacitor-swift-pm")
+            ],
+            path: "ios/Sources/PdfGeneratorPlugin"),
+        .testTarget(
+            name: "PdfGeneratorPluginTests",
+            dependencies: ["PdfGeneratorPlugin"],
+            path: "ios/Tests/PdfGeneratorPluginTests")
+    ]
+)

package/README.md ADDED Viewed

@@ -0,0 +1,112 @@
+# @capgo/capacitor-pdf-generator
+ <a href="https://capgo.app/"><img src='https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png' alt='Capgo - Instant updates for capacitor'/></a>
+<div align="center">
+  <h2><a href="https://capgo.app/?ref=plugin"> ➡️ Get Instant updates for your App with Capgo</a></h2>
+  <h2><a href="https://capgo.app/consulting/?ref=plugin"> Missing a feature? We’ll build the plugin for you 💪</a></h2>
+</div>
+Generate PDF files from HTML strings or remote URLs.
+Port of the Cordova [pdf-generator](https://github.com/feedhenry-staff/pdf-generator) plugin for Capacitor with a modernized native implementation.
+## Install
+```bash
+npm install @capgo/capacitor-pdf-generator
+npx cap sync
+```
+## Usage
+```ts
+import { PdfGenerator } from '@capgo/capacitor-pdf-generator';
+const result = await PdfGenerator.fromData({
+  data: '<html><body><h1>Hello Capgo</h1></body></html>',
+  documentSize: 'A4',
+  orientation: 'portrait',
+  type: 'base64',
+  fileName: 'example.pdf',
+});
+if (result.type === 'base64') {
+  console.log(result.base64);
+}
+```
+## API
+<docgen-index>
+* [`fromURL(...)`](#fromurl)
+* [`fromData(...)`](#fromdata)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+</docgen-index>
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+### fromURL(...)
+```typescript
+fromURL(options: PdfGeneratorFromUrlOptions) => Promise<PdfGeneratorResult>
+```
+Generates a PDF from the provided URL.
+| Param         | Type                                                                              |
+| ------------- | --------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#pdfgeneratorfromurloptions">PdfGeneratorFromUrlOptions</a></code> |
+**Returns:** <code>Promise&lt;<a href="#pdfgeneratorresult">PdfGeneratorResult</a>&gt;</code>
+--------------------
+### fromData(...)
+```typescript
+fromData(options: PdfGeneratorFromDataOptions) => Promise<PdfGeneratorResult>
+```
+Generates a PDF from a raw HTML string.
+| Param         | Type                                                                                |
+| ------------- | ----------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#pdfgeneratorfromdataoptions">PdfGeneratorFromDataOptions</a></code> |
+**Returns:** <code>Promise&lt;<a href="#pdfgeneratorresult">PdfGeneratorResult</a>&gt;</code>
+--------------------
+### Interfaces
+#### PdfGeneratorFromUrlOptions
+| Prop      | Type                |
+| --------- | ------------------- |
+| **`url`** | <code>string</code> |
+#### PdfGeneratorFromDataOptions
+| Prop          | Type                | Description                                                                                                    |
+| ------------- | ------------------- | -------------------------------------------------------------------------------------------------------------- |
+| **`data`**    | <code>string</code> | HTML document to render.                                                                                       |
+| **`baseUrl`** | <code>string</code> | Base URL to use when resolving relative resources inside the HTML string. When omitted, `about:blank` is used. |
+### Type Aliases
+#### PdfGeneratorResult
+<code>{ type: 'base64'; base64: string; } | { type: 'share'; completed: boolean; }</code>
+</docgen-api>

package/android/build.gradle ADDED Viewed

@@ -0,0 +1,57 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.7.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.2.1'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.6.1'
+}
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.7.2'
+    }
+}
+apply plugin: 'com.android.library'
+android {
+    namespace "app.capgo.pdfgenerator"
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 35
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 35
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
+    }
+}
+repositories {
+    google()
+    mavenCentral()
+}
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml ADDED Viewed

@@ -0,0 +1,13 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application>
+        <provider
+            android:name="androidx.core.content.FileProvider"
+            android:authorities="${applicationId}.capgo.pdfgenerator.fileprovider"
+            android:exported="false"
+            android:grantUriPermissions="true">
+            <meta-data
+                android:name="android.support.FILE_PROVIDER_PATHS"
+                android:resource="@xml/capgo_pdf_generator_paths" />
+        </provider>
+    </application>
+</manifest>

package/android/src/main/java/android/print/CapgoPdfPrintUtils.java ADDED Viewed

@@ -0,0 +1,210 @@
+package android.print;
+import android.content.Context;
+import android.os.CancellationSignal;
+import android.os.ParcelFileDescriptor;
+import android.util.Base64;
+import androidx.annotation.NonNull;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.FileInputStream;
+/**
+ * Internal helpers to generate PDF output from a PrintDocumentAdapter without relying on
+ * platform print dialogs. Located inside the {@code android.print} package so we can access
+ * the package-private constructors of the framework callbacks.
+ */
+public final class CapgoPdfPrintUtils {
+    private CapgoPdfPrintUtils() {}
+    public interface Base64Callback {
+        void onSuccess(@NonNull String base64);
+        void onError(@NonNull String message);
+    }
+    public interface FileCallback {
+        void onSuccess(@NonNull File file);
+        void onError(@NonNull String message);
+    }
+    public static void createBase64(
+        Context context,
+        PrintDocumentAdapter adapter,
+        PrintAttributes attributes,
+        Base64Callback callback
+    ) {
+        Writer writer = new Writer(adapter, attributes);
+        writer.writeToTempFile(
+            context,
+            new Writer.FileResultCallback() {
+                @Override
+                public void onSuccess(@NonNull File file, @NonNull ParcelFileDescriptor descriptor) {
+                    new Thread(
+                        () -> {
+                            try {
+                                String base64 = PdfIoUtils.readBase64(file);
+                                callback.onSuccess(base64);
+                            } catch (Exception ex) {
+                                callback.onError("Failed to convert PDF to base64.");
+                            } finally {
+                                PdfIoUtils.closeQuietly(descriptor);
+                                // best-effort cleanup
+                                //noinspection ResultOfMethodCallIgnored
+                                file.delete();
+                            }
+                        }
+                    )
+                    .start();
+                }
+                @Override
+                public void onError(@NonNull String message) {
+                    callback.onError(message);
+                }
+            }
+        );
+    }
+    public static void writeToFile(
+        Context context,
+        PrintDocumentAdapter adapter,
+        PrintAttributes attributes,
+        File target,
+        FileCallback callback
+    ) {
+        Writer writer = new Writer(adapter, attributes);
+        writer.writeToFile(
+            context,
+            target,
+            new Writer.FileResultCallback() {
+                @Override
+                public void onSuccess(@NonNull File file, @NonNull ParcelFileDescriptor descriptor) {
+                    PdfIoUtils.closeQuietly(descriptor);
+                    callback.onSuccess(file);
+                }
+                @Override
+                public void onError(@NonNull String message) {
+                    callback.onError(message);
+                }
+            }
+        );
+    }
+    private static final class Writer {
+        interface FileResultCallback {
+            void onSuccess(@NonNull File file, @NonNull ParcelFileDescriptor descriptor);
+            void onError(@NonNull String message);
+        }
+        private static final PageRange[] ALL_PAGES = new PageRange[] { PageRange.ALL_PAGES };
+        private final PrintDocumentAdapter adapter;
+        private final PrintAttributes attributes;
+        Writer(PrintDocumentAdapter adapter, PrintAttributes attributes) {
+            this.adapter = adapter;
+            this.attributes = attributes;
+        }
+        void writeToTempFile(Context context, FileResultCallback callback) {
+            try {
+                File tempFile = File.createTempFile("capgo_pdf_generator", ".pdf", context.getCacheDir());
+                writeToDescriptor(tempFile, callback);
+            } catch (Exception ex) {
+                callback.onError("Failed to create temporary file for PDF.");
+            }
+        }
+        void writeToFile(Context context, File file, FileResultCallback callback) {
+            try {
+                if (file.exists() && !file.delete()) {
+                    callback.onError("Failed to override existing PDF file.");
+                    return;
+                }
+                File parent = file.getParentFile();
+                if (parent != null && !parent.exists() && !parent.mkdirs()) {
+                    callback.onError("Failed to prepare output directory for PDF.");
+                    return;
+                }
+                writeToDescriptor(file, callback);
+            } catch (Exception ex) {
+                callback.onError("Failed to prepare PDF output file.");
+            }
+        }
+        private void writeToDescriptor(File file, FileResultCallback callback) {
+            try {
+                ParcelFileDescriptor descriptor = ParcelFileDescriptor.open(
+                    file,
+                    ParcelFileDescriptor.MODE_CREATE | ParcelFileDescriptor.MODE_READ_WRITE | ParcelFileDescriptor.MODE_TRUNCATE
+                );
+                CancellationSignal cancellationSignal = new CancellationSignal();
+                adapter.onLayout(
+                    null,
+                    attributes,
+                    cancellationSignal,
+                    new PrintDocumentAdapter.LayoutResultCallback() {
+                        @Override
+                        public void onLayoutFailed(CharSequence error) {
+                            callback.onError("PDF layout failed: " + (error == null ? "" : error));
+                        }
+                        @Override
+                        public void onLayoutFinished(PrintDocumentInfo info, boolean changed) {
+                            adapter.onWrite(
+                                ALL_PAGES,
+                                descriptor,
+                                cancellationSignal,
+                                new PrintDocumentAdapter.WriteResultCallback() {
+                                    @Override
+                                    public void onWriteFinished(PageRange[] pages) {
+                                        callback.onSuccess(file, descriptor);
+                                    }
+                                    @Override
+                                    public void onWriteFailed(CharSequence error) {
+                                        callback.onError("PDF write failed: " + (error == null ? "" : error));
+                                    }
+                                }
+                            );
+                        }
+                    },
+                    null
+                );
+            } catch (Exception ex) {
+                callback.onError("Failed to create PDF output.");
+            }
+        }
+    }
+    private static final class PdfIoUtils {
+        private PdfIoUtils() {}
+        static String readBase64(File file) throws Exception {
+            FileInputStream inputStream = new FileInputStream(file);
+            try (ByteArrayOutputStream outputStream = new ByteArrayOutputStream()) {
+                byte[] buffer = new byte[8192];
+                int read;
+                while ((read = inputStream.read(buffer)) != -1) {
+                    outputStream.write(buffer, 0, read);
+                }
+                return Base64.encodeToString(outputStream.toByteArray(), Base64.NO_WRAP);
+            } finally {
+                inputStream.close();
+            }
+        }
+        static void closeQuietly(ParcelFileDescriptor descriptor) {
+            if (descriptor == null) {
+                return;
+            }
+            try {
+                descriptor.close();
+            } catch (Exception ignored) {}
+        }
+    }
+}